box(3) [netbsd man page]
CURSES_BORDER(3) BSD Library Functions Manual CURSES_BORDER(3) NAME
curses_border, border, box, wborder -- curses border drawing routines LIBRARY
Curses Library (libcurses, -lcurses) SYNOPSIS
#include <curses.h> int border(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br); int box(WINDOW *win, chtype vertical, chtype horizontal); int wborder(WINDOW *win, chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br); DESCRIPTION
These functions draw borders around stdscr or around the specified window. The border() function draws a border around stdscr using the characters given as arguments to the function. The ls, rs, ts and bs are the characters used to draw the left, right, top and bottom sides, respectively. The tl, tr, bl and br are the characters used to draw the top- left, top-right, bottom-left and bottom-right corners, respectively. If any of the characters have a text portion that is 0 then a default alternate character set character is used for that character. Note that even though the text portion of the argument is 0, the argument can still be used to specify the attributes for that portion of the border. The following table shows the default characters for each argument: ls ACS_VLINE rs ACS_VLINE ts ACS_HLINE bs ACS_HLINE tl ACS_ULCORNER tr ACS_URCORNER bl ACS_LLCORNER br ACS_LRCORNER wborder() is the same as border() excepting that the border is drawn around the specified window. The box() command draws a box around the window given in win using the vertical character for the vertical lines and the horizontal character for the horizontal lines. The corner characters of this box will be the defaults as described for border() above. Passing characters with text portion that is 0 to box() will result in the same defaults as those for border() as described above. RETURN VALUES
Functions returning pointers will return NULL if an error is detected. The functions that return an int will return one of the following values: OK The function completed successfully. ERR An error occurred in the function. SEE ALSO
curses_attributes(3), curses_line(3) STANDARDS
The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification. HISTORY
The Curses package appeared in 4.0BSD. BSD
August 12, 2002 BSD
Check Out this Related Man Page
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 rendi- tion 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 ALSO
add_wch(3XCURSES), addch(3XCURSES), attr_get(3XCURSES), attroff(3XCURSES), border_set(3XCURSES), libcurses(3XCURSES), attributes(5), stan- dards(5) SunOS 5.10 5 Jun 2002 border(3XCURSES)