NAME

curs_border, border, wborder, box, hline, whline, mvhline, mvwhline, vline, wvline, mvvline, mvwvline − Create Curses borders, and horizontal and vertical lines

LIBRARY

Curses Library (libcurses.a, libcurses.so)

SYNOPSIS

#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 mvhline(int y, int x, chtype ch,
        int n);
int mvwhline(WINDOW ∗win, int y, int x,
        chtype ch, int n);
int vline(chtype ch, int n);
int wvline(WINDOW ∗win, chtype ch, int n);
int mvvline(int y, int x, chtype ch, int n);
int mvwvline(WINDOW ∗win, int y, int x,
        chtype ch, int n);

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

box: XPG4, XPG4−UNIX

border, wborder, hline, whline, mvhline, mvwhline, vline, wvline, mvvline, mvwvline: XPG4−UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags. 

DESCRIPTION

The border, wborder, and box routines draw a border around the edges of the window.  Each of the following arguments contains both a character and attributes for a particular part of the border:

lsLeft side

rsRight side

tsTop

bsBottom

tlTop left-hand corner

trTop right-hand corner

blBottom left-hand corner

brBottom right-hand corner

If any of these arguments is zero, then the functions use the following default values (which are defined in curses.h): ACS_VLINE, ACS_VLINE, ACS_HLINE, ACS_HLINE, ACS_ULCORNER, ACS_URCORNER, ACS_LLCORNER, and ACS_LRCORNER. 

The call box(win, verch, horch); is equivalent to the following call:

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

The hline, whline, mvhline, and mvwhline functions use ch to draw a horizontal (left-to-right) line, starting at the current or specified cursor position in the current or specified window.  The current cursor position is not changed.  The line is at most n characters long, or as many characters as can fit into the window. 

The vline, wvline, mvvline, and mvwvline functions use ch to draw a vertical (top-to-bottom) line, starting at the current or specified cursor position in the current or specified window.  The current cursor position is not changed.  The line is at most n characters long, or as many characters as can fit into the window. 

NOTES

The header file curses.h automatically includes the header file stdio.h. 

Note that border and box may be macros. 

RETURN VALUES

All routines return OK on success or ERR on failure. 

RELATED INFORMATION

Functions: curses(3), curs_border_set(3), curs_outopts(3)

Others: standards(5)