xref: /illumos-gate/usr/src/man/man3xcurses/border.3xcurses (revision 3299f39fdcbdab4be7a9c70daa3873f2b78a398d) 
 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 3XCURSES "Jun 5, 2002"
 NAME
border, box, wborder - add a single-byte border to a window

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




 DESCRIPTION

The border() and wborder() functions draw a border around the
specified window. All parameters must be single-byte characters whose
rendition can be expressed using only constants beginning with ACS_. A
parameter with the value of 0 is replaced by the default value.






Constant Values for Borders
Parameter Default Constant Default Character
verch  ACS_VLINE |
horch  ACS_HLINE -
ls ACS_VLINE |
rs ACS_VLINE |
ts ACS_HLINE -
bs ACS_HLINE -
bl ACS_BLCORNER +
br ACS_BRCORNER +
tl ACS_ULCORNER +
tr ACS_URCORNER +




The call

box(win,
verch, horch)





is a short form for

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





When the window is boxed, the bottom and top rows and right and left columns
overwrite existing text.

 PARAMETERS
ls


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



rs


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



ts


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



bs


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



tl


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



tr


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



bl


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



br


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






ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe



 SEE ALSO

add_wch(3XCURSES), addch(3XCURSES), attr_get(3XCURSES),
attroff(3XCURSES), border_set(3XCURSES), libcurses(3XCURSES),
attributes(5), standards(5)