te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
curs_border, border, wborder, box, whline, wvline - create curses borders, horizontal and vertical lines

cc [ 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);

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);

With the border(), wborder(), and box() routines, a border is drawn around the edges of the window. The arguments and attributes are:

ls left side of the border

rs right side of the border

ts top side of the border

bs bottom side of the border

tl top left-hand corner

tr top right-hand corner

bl bottom left-hand corner

br bottom right-hand corner

If any of these arguments is zero, then the following default values (defined in <curses.h>) are used respectively instead: ACS_VLINE, ACS_VLINE, ACS_HLINE, ACS_HLINE, ACS_ULCORNER, ACS_URCORNER, ACS_BLCORNER, ACS_BRCORNER.

box(win, verch, horch) is a shorthand for the following call:

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

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

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

All routines return the integer OK, or a non-negative integer if immedok() is set. See curs_outopts(3CURSES).

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

MT-Level Unsafe

curs_outopts(3CURSES), curses(3CURSES), attributes(5)

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that border() and box() may be macros.