border_set.3xcurses (revision bbf215553c7233fbab8a0afdf1fac74c44781867) - OpenGrok cross reference for /illumos-gate/usr/src/man/man3xcurses/border

te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved 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]

BORDER_SET 3XCURSES "Jun 5, 2002"

NAME

border_set, box_set, wborder_set - use complex characters (and renditions) to draw borders

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int border_set(const cchar_t *ls, const cchar_t *rs, const cchar_t *ts,
 const cchar_t *bs, const cchar_t *tl, const cchar_t *tr,
 const cchar_t *bl,const cchar_t *br);

int wborder_set(WINDOW *win, const cchar_t *ls, const cchar_t *rs,
 const cchar_t *ts,const cchar_t *bs, const cchar_t *tl,
 const cchar_t *tr, const cchar_t *bl,const cchar_t *br);

int box_set(WINDOW *win, const cchar_t *verch, const cchar_t *horch);

DESCRIPTION

The border_set() and wborder_set() functions draw a border around the specified window. All parameters must be spacing complex characters with renditions. A parameter which is a null pointer is replaced by the default character.

Constant Values for Borders

Parameter Default Constant Default Character

verch WACS_VLINE |

horch WACS_HLINE -

ls WACS_VLINE |

rs WACS_VLINE |

ts WACS_HLINE -

bs WACS_HLINE -

bl WACS_BLCORNER +

br WACS_BRCORNER +

tl WACS_ULCORNER +

tr WACS_URCORNER +

The call

box_set(win,
verch, horch)

is a short form for

wborder(win,
verch, verch,
horch, horch, NULL,
NULL, NULL, NULL)

When the window is boxed, the bottom and top rows and right and left columns are unavailable for text.

PARAMETERS

Is the character and rendition used for the left side of the border.

Is the character and rendition used for the right side of the border.

Is the character and rendition used for the top of the border.

Is the character and rendition used for the bottom of the border.

Is the character and rendition used for the top-left corner of the border.

Is the character and rendition used for the top-right corner of the border.

Is the character and rendition used for the bottom-left corner of the border.

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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Standard

MT-Level Unsafe