CURSES_BORDER(3)

CURSES_BORDER(3) | NetBSD 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.

August 12, 2002 | NetBSD 5.99