border_set(3X)

ENHANCED CURSES

NAME

border_set, wborder_set — draw borders from complex characters and renditions

SYNOPSIS

#include <curses.h>

int border_set(cchar_t *const ls, cchar_t *const rs, cchar_t *const ts,
cchar_t *const bs, cchar_t *const tl, cchar_t *const tr,
cchar_t *const bl, cchar_t *const br);

int wborder_set(WINDOW *win, cchar_t *const ls, cchar_t *const rs,
               cchar_t *const ts, cchar_t *const bs,
               cchar_t *const tl, cchar_t *const tr,
               cchar_t *const bl, cchar_t *const br);

DESCRIPTION

The border_set() and wborder_set() functions draw a border around the edges of the current or specified window. These functions do not advance the cursor position. These functions do not perform special character processing. These functions do not perform wrapping.

The arguments in the left-hand column of the following table contain spacing complex characters with renditions, which have the following uses in drawing the border:

Argument		Default
Name	Usage	Value
ls	Starting-column side	WACS_VLINE
rs	Ending-column side	WACS_VLINE
ts	First-line side	WACS_HLINE
bs	Last-line side	WACS_HLINE
tl	Corner of the first line and the starting column	WACS_ULCORNER
tr	Corner of the first line and the ending column	WACS_URCORNER
bl	Corner of the last line and the starting column	WACS_BLCORNER
br	Corner of the last line and the ending column	WACS_BRCORNER

If the value of any argument in the left-hand column is a null pointer, then the default value in the right-hand column is used. If the value of any argument in the left-hand column is a multi-column character, the results are undefined.

RETURN VALUE

Upon successful completion, these functions return OK. Otherwise, they return ERR.

ERRORS

No errors are defined.

CHANGE HISTORY

First released in X/Open Curses, Issue 4.

Hewlett-Packard Company — HP-UX Release 10.20: July 1996

Museum