border(3XCURSES) X/Open Curses Library Functions border(3XCURSES)NAME
border, box, wborder - add a single-byte border to a window
SYNOPSIS
cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]
c89 [ flag... ] file... -lcurses [ library... ]
#include <curses.h>
int border(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl,
chtype tr, chtype bl, chtype br);
int wborder(WINDOW *win, chtype ls, chtype rs, chtype ts, chtype bs,
chtype tl, chtype tr, chtype bl, chtype br);
int box(WINDOW *win, chtype verch, chtype horch);
DESCRIPTION
The border() and wborder() functions draw a border around the specified
window. All parameters must be single-byte characters whose rendition
can be expressed using only constants beginning with ACS_. A parameter
with the value of 0 is replaced by the default value.
┌──────────────────────────────────────────────────────────────┐
│ Constant Values for Borders │
│Parameter Default Constant Default Character │
│verch ACS_VLINE | │
│horch ACS_HLINE - │
│ls ACS_VLINE | │
│rs ACS_VLINE | │
│ts ACS_HLINE - │
│bs ACS_HLINE - │
│bl ACS_BLCORNER + │
│br ACS_BRCORNER + │
│tl ACS_ULCORNER + │
│tr ACS_URCORNER + │
└──────────────────────────────────────────────────────────────┘
The call
box(win,
verch, horch)
is a short form for
wborder(win,
verch, verch,
horch, horch, 0, 0, 0,
0)
When the window is boxed, the bottom and top rows and right and left
columns overwrite existing text.
PARAMETERS
ls Is the character and rendition used for the left side
of the border.
rs Is the character and rendition used for the right side
of the border.
ts Is the character and rendition used for the top of the
border.
bs Is the character and rendition used for the bottom of
the border.
tl Is the character and rendition used for the top-left
corner of the border.
tr Is the character and rendition used for the top-right
corner of the border.
bl Is the character and rendition used for the bottom-left
corner of the border.
br Is the character and rendition used for the bottom-
right corner of the border.
win Is the pointer to the window in which the border or box
is to be drawn.
verch Is the character and rendition used for the left and
right columns of the box.
horch Is the character and rendition used for the top and
bottom rows of the box.
RETURN VALUES
On success, these functions return OK. Otherwise, they return ERR.
ERRORS
None.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────┤
│Interface Stability │Standard │
├─────────────────────────────┼─────────────────────────────┤
│MT-Level │Unsafe │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSOadd_wch(3XCURSES), addch(3XCURSES), attr_get(3XCURSES),
attroff(3XCURSES), border_set(3XCURSES), libcurses(3XCURSES),
attributes(5), standards(5)SunOS 5.10 5 Jun 2002 border(3XCURSES)