border_set


HOME

border_set

NAME
SYNOPSIS
DESCRIPTION
NOTES
RETURN VALUE
SEE ALSO

NAME

border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set, mvwhline_set, vline_set, wvline_set, mvvline_set, mvwvline_set − create curses borders or lines using complex characters and renditions

SYNOPSIS

#include <ncurses/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);
int hline_set(
const cchar_t *
wch, int n);
int whline_set(
WINDOW *
win,
const cchar_t *
wch, int n);
int mvhline_set(
int
y, int x,
const cchar_t *
wch, int n);
int mvwhline_set(
WINDOW *
win,
int
y, int x,
const cchar_t *
wch, int n);
int vline_set(
const cchar_t *
wch, int n);
int wvline_set(
WINDOW *
win,
const cchar_t *
wch, int n);
int mvvline_set(
int
y, int x,
const cchar_t *
wch, int n);
int mvwvline_set(
WINDOW *
win,
int
y, int x,
const cchar_t *
wch, int n);

DESCRIPTION

The border_set and wborder_set functions draw a border around the edges of the current or specified window. These functions do not change the cursor position, and do not wrap.

Other than the window, each argument is a complex character with attributes:

ls − left side,
rs
− right side,
ts
− top side,
bs
− bottom side,
tl
− top left-hand corner,
tr
− top right-hand corner,
bl
− bottom left-hand corner, and
br
− bottom right-hand corner.

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

WACS_VLINE,
WACS_VLINE
,
WACS_HLINE
,
WACS_HLINE
,
WACS_ULCORNER
,
WACS_URCORNER
,
WACS_LLCORNER
, and
WACS_LRCORNER
.

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

wborder_set(win, verch, verch,
horch
, horch, NULL, NULL, NULL, NULL);

The *line_set functions use wch to draw a line starting at the current cursor position in the window. The line is at most n characters long or as many as fit into the window. The current cursor position is not changed.

The hline_set, mvhline_set, mvwhline_set, and whline_set functions draw a line proceeding toward the last column of the same line.

The vline_set, mvvline_set, mvwvline_set, and wvline_set functions draw a line proceeding toward the last line of the window.

NOTES

Note that border_set, hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, and vline_set may be macros.

RETURN VALUE

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

Functions using a window parameter return an error if it is null.

Functions with a "mv" prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null.

SEE ALSO

ncurses(3NCURSES), add_wch(3NCURSES), border(3NCURSES), outopts(3NCURSES)




More Linux Commands

manpages/XwcDrawImageString.3.html
XwcDrawImageString(3) - draw image text using a single font
The XmbDrawImageString, XwcDrawImageString and Xutf8DrawImageString functions fill a destination rectangle with the background pixel defined in the GC and then

manpages/lfind.3.html
lfind(3) - linear search of an array - Linux manual page....
lfind.3 - lfind() and lsearch() perform a linear search for key in the array base which has *nmemb elements of size bytes each. The comparison function referenc

manpages/ldap_open.3.html
ldap_open(3) - Initialize the LDAP library and open a connec
ldap_open() opens a connection to an LDAP server and allocates an LDAP structure which is used to identify the connection and to maintain per-connection informa

manpages/Bootloader::Tools.3pm.html
Bootloader::Tools(3pm) - set of high-level bootloader config
$mp_ref = Bootloader::Tools::ReadMountPoints (); reads the information about mountpoints in the system. The returned data is needed to initialize the bootloader

manpages/is_nodelay.3ncurses.html
is_nodelay(3ncurses) - curses window properties (Man Page)
This implementation provides functions which return properties set in the WINDOW structure, allowing it to be opaque if the symbol NCURSES_OPAQUE is defined: is

manpages/SDL_PumpEvents.3.html
SDL_PumpEvents(3) - Pumps the event loop, gathering events f
Pumps the event loop, gathering events from the input devices. SDL_PumpEvents gathers all the pending input information from devices and places it on the event

manpages/menu_back.3menu.html
menu_back(3menu) - color and attribute control for menus....
The function set_menu_fore sets the foreground attribute of menu. This is the highlight used for selected menu items. menu_fore returns the foreground attribute

manpages/uuid_parse.3.html
uuid_parse(3) - convert an input UUID string into binary rep
The uuid_parse function converts the UUID string given by in into the binary representation. The input UUID is a string of the form 1b4e28ba-2fa1-11d2-883f-b9a7

manpages/traceroute.8.html
traceroute(8) print the route packets trace to network host
traceroute tracks the route packets taken from an IP network on their way to a given host. It utilizes the IP protocols time to live (TTL) field and attempts to

manpages/strtouq.3.html
strtouq(3) - convert a string to an unsigned long integer...
The strtoul() function converts the initial part of the string in nptr to an unsigned long int value according to the given base, which must be between 2 and 36

manpages/nmblookup4.1.html
nmblookup4(1) NetBIOS over TCP IP client used to lookup NetB
This tool is part of the samba(7) suite. nmblookup4 is used to query NetBIOS names and map them to IP addresses in a network using NetBIOS over TCP/IP queries.

manpages/tdfx.4.html
tdfx(4) - 3Dfx video driver (Special - Linux man page)......
tdfx is an Xorg driver for 3Dfx video cards. SUPPORTED HARDWARE The tdfx driver supports Voodoo Banshee, Voodoo3, Voodoo4 and Voodoo5 cards. CONFIGURATION DETAI





We can't live, work or learn in freedom unless the software we use is free.