curs_border_set - Online Linux Manual Page

Section : 3X
Updated :

NAME

border_set

wborder_set

box_set

hline_set

whline_set

mvhline_set

mvwhline_set

vline_set

wvline_set

mvvline_set

mvwvline_set

− create

curses

borders or lines using complex characters and renditions

SYNOPSIS

#include <curses.h>

int border_set(

const cchar_t *

);

int wborder_set(

WINDOW *win

const cchar_t *

);

int box_set(

WINDOW *win

const cchar_t *

verch

const cchar_t *

horch

);

int hline_set(

const cchar_t *

wch

int

);

int whline_set(

WINDOW *

win

const cchar_t *

wch

int

);

int mvhline_set(

int

const cchar_t *

wch

int

);

int mvwhline_set(

WINDOW *

win

int

const cchar_t *

wch

int

);

int vline_set(

const cchar_t *

wch

int

);

int wvline_set(

WINDOW *

win

const cchar_t *

wch

int

);

int mvvline_set(

int

const cchar_t *

wch

int

);

int mvwvline_set(

WINDOW *

win

int

const cchar_t *

wch

int

);

DESCRIPTION

The border_set

and

wborder_set

functions draw a border around the edges of the current or specified window. These functions do not change the cursor position, and do not wrap.

Other than the window, each argument is a complex character with attributes:

− left side,

− right side,

− top side,

− bottom side,

− top left-hand corner,

− top right-hand corner,

− bottom left-hand corner, and

− bottom right-hand corner.

If any of these arguments is zero, then the corresponding default values (defined in curses.h

) are used instead:

WACS_VLINE

WACS_HLINE

WACS_ULCORNER

WACS_URCORNER

WACS_LLCORNER

, and

WACS_LRCORNER

box_set(

win

verch

horch

);

is a shorthand for the following call:

wborder_set(

win

verch

horch

, NULL, NULL, NULL, NULL);

The *line_set

functions use

wch

to draw a line starting at the current cursor position in the window. The line is at most

characters long or as many as fit into the window. The current cursor position is not changed.

The hline_set

mvhline_set

mvwhline_set

, and

whline_set

functions draw a line proceeding toward the last column of the same line.

The vline_set

mvvline_set

mvwvline_set

, and

wvline_set

functions draw a line proceeding toward the last line of the window.

NOTES

Note that border_set

hline_set

mvhline_set

mvvline_set

mvwhline_set

mvwvline_set

, and

vline_set

may be macros.

RETURN VALUE

Upon successful completion, these functions return OK

. Otherwise, they return

ERR

Functions using a window parameter return an error if it is null.

Functions with a ‟mv” prefix first perform a cursor movement using wmove

, and return an error if the position is outside the window, or if the window pointer is null.