xref: /illumos-gate/usr/src/man/man3xcurses/hline_set.3xcurses (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
HLINE_SET 3XCURSES "Jun 5, 2002"
NAME
hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, vline_set, whline_set, wvline_set - use complex characters (and renditions) to draw lines
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int hline_set(const cchar_t *ch, int n);

int mvhline_set(int y, int x, const cchar_t *wch, int n);

int mvvline_set(int y, int x, const cchar_t *wch, int n);

int mvwhline_set(WINDOW *win, int y, int x, const cchar_t *wch, int n);

int mvwvline_set(WINDOW *win, int y, int x, const cchar_t *wch, int n);

int vline_set(const cchar_t *wch, int n);

int whline_set(WINDOW *win, const cchar_t *wch, int n);

int wvline_set(WINDOW *win, const cchar_t *wch, int n);
DESCRIPTION

The hline_set(), vline_set(), whline_set(), wvline_set() functions draw a line, in either the window stdscr or win starting at the current cursor position. The line is drawn using the character wch and is a maximum of n positions long, or as many as will fit into the window. If wch is a null pointer, the default horizontal or vertical character is used.

The mvhline_set(), mvvline_set(), mvwhline_set(), mvwvline_set() functions are similar to the previous group of functions but the line begins at cursor position specified by x and y.

The functions with names ending with hline_set() draw horizontal lines proceeding towards the last column of the same line. The functions with names ending with vline_set() draw vertical lines proceeding towards the last column of the same line.

These functions do not change the position of the cursor.

PARAMETERS
wch

Is the complex character used to draw the line.

n

Is the maximum number of characters in the line.

y

Is the y (row) coordinate for the start of the line.

x

Is the x (column) coordinate for the start of the line.

win

Is a pointer to a window.

RETURN VALUES

On success, these functions return OK. Otherwise, they return ERR.

ERRORS

None.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

border (3XCURSES), border_set (3XCURSES), hline (3XCURSES), libcurses (3XCURSES), attributes (7), standards (7)