border(3curses)


border -- draw borders from single-byte characters and renditions

Synopsis

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

Description

The border(3curses) and wborder(3curses) functions draw a border around the edges of the current or specified window. These functions do not advance the cursor position. These functions do not perform special character processing. These functions do not perform wrapping.

The arguments in the left-hand column of the following table contain single-byte characters with renditions, which have the following uses in drawing the border:

Arg Usage Default Value
ls Starting-column side ACS_VLINE
rs Ending-column side ACS_VLINE
ts First-line side ACS_HLINE
bs Last-line side ACS_HLINE
tl Corner of the first line and the starting column ACS_ULCORNER
tr Corner of the first line and the ending column ACS_URCORNER
bl Corner of the last line and the starting column ACS_LLCORNER
br Corner of the last line and the ending column ACS_LRCORNER

                 +----+----------------------+---------------+
                 |Arg |        Usage         | Default Value |
                 +----+----------------------+---------------+
                 |ls  | Starting-column side | ACS_VLINE     |
                 +----+----------------------+---------------+
                 |rs  | Ending-column side   | ACS_VLINE     |
                 +----+----------------------+---------------+
                 |ts  | First-line side      | ACS_HLINE     |
                 +----+----------------------+---------------+
                 |bs  | Last-line side       | ACS_HLINE     |
                 +----+----------------------+---------------+
                 |tl  | Corner of the first  | ACS_ULCORNER  |
                 |    | line and the         |               |
                 |    | starting column      |               |
                 +----+----------------------+---------------+
                 |tr  | Corner of the first  | ACS_URCORNER  |
                 |    | line and the ending  |               |
                 |    | column               |               |
                 +----+----------------------+---------------+
                 |bl  | Corner of the last   | ACS_LLCORNER  |
                 |    | line and the         |               |
                 |    | starting column      |               |
                 +----+----------------------+---------------+
                 |br  | Corner of the last   | ACS_LRCORNER  |
                 |    | line and the ending  |               |
                 |    | column               |               |
                 +----+----------------------+---------------+

If the value of any argument in the left-hand column is 0, then the default value in the right-hand column is used. If the value of any argument in the left-hand column is a multi-column character, the results are undefined.

Return value

Upon successful completion, these functions return OK. Otherwise, they return ERR.

Errors

No errors are defined.

Usage

These functions are only guaranteed to operate reliably on character sets in which each character fits into a single byte, whose attributes can be expressed using only constants with the A_ prefix.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

border_set(3curses), box(3curses), hline(3curses), curses(4)
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 25 April 2004