***************************************************************************
Copyright 2018-2023,2024 Thomas E. Dickey *
Copyright 1998-2007,2010 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_border.3x,v 1.49 2024/04/20 21:20:07 tom Exp $
.\} .\} \%border, \%wborder, \%box, \%hline, \%whline, \%vline, \%wvline, \%mvhline, \%mvwhline, \%mvvline, \%mvwvline - draw borders and lines in a curses window of characters

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

int mvhline(int y, int x, chtype ch, int n);
int mvwhline(WINDOW *win, int y, int x, 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);

The border, wborder and box routines draw a box around the edges of a window. Other than the window, each argument is a character with attributes:

If any of these arguments is zero, then the corresponding default values (defined in curses.h) are used instead:

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

The hline and whline functions 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.

The vline and wvline functions 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. The SVr4.0 manual says \*(``or a non-negative integer if \%immedok is set\*('', but this appears to be an error.

X/Open Curses does not specify any error conditions. This implementation returns an error if the window pointer is null.

Functions prefixed with \*(``mv\*('' first perform cursor movement and fail if the position ( y , x ) is outside the window boundaries.

The borders generated by these functions are inside borders (this is also true of SVr4 curses, though the fact is not documented).

Note that border and box may be macros.

These functions are described in X/Open Curses, Issue 4. \%curses(3X), \%curs_outopts(3X)