curs_border(S-osr5)

curs_border: border, wborder, box, hline, whline, vline, wvline -- create curses borders, horizontal and vertical lines

Syntax

cc ... -lcurses

#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);
int hline(chtype ch, int n);
int whline(WINDOW *win, chtype ch, int n);
int vline(chtype ch, int n);
int wvline(WINDOW *win, chtype ch, int n);

Description

The routines border(S-osr5), wborder(S-osr5), and box(S-osr5) draw a border around the edges of the window. Each of the following arguments is a character and its attributes:

ls: left side
rs: right side
ts: top side
bs: bottom side
tl: top left corner
tr: top right corner
bl: bottom left corner
br: bottom right corner

If an argument is zero, the following default value is used instead:

ls: ACS_VLINE
rs: ACS_VLINE
ts: ACS_HLINE
bs: ACS_HLINE
tl: ACS_ULCORNER
tr: ACS_URCORNER
bl: ACS_LLCORNER
br: ACS_LRCORNER

These values are defined in curses.h.

The sequence

box(win, verch, horch)

is a shorthand for the following call:

   wborder(win, verch, verch, horch, horch, 0, 0, 0, 0)

hline(S-osr5) and whline(S-osr5) draw a horizontal line of character ch to the right from the current cursor position. The cursor does not move. The line is at most n characters long, or as many as fit into the window.

vline(S-osr5) and wvline(S-osr5) draw a vertical line of character ch down from the current cursor position. The cursor does not move. The line is at most n characters long, or as many as fit into the window.

Return values

All routines return the integer OK, or a non-negative integer if immedok(S-osr5) is set.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: border( ) and box( ).

Files

/usr/lib/libcurses.a: the library

Standards conformance

box(S-osr5), border(S-osr5), wborder(S-osr5), hline(S-osr5), whline(S-osr5), vline(S-osr5), and wvline(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.