curs_slk, slk_attr_off, slk_attr_on, slk_attr_set,
slk_attroff, slk_attron, slk_attrset, slk_clear,
slk_color, slk_init, slk_label, slk_noutrefresh,
slk_refresh, slk_restore, slk_set, slk_wset, slk_touch -
Curses soft-label routines
#include <curses.h>
int slk_attr_off(
const attr_t attrs,
void *opts ); int slk_attr_on(
const attr_t attrs,
void *opts ); int slk_attr_set(
const attr_t attrs,
short color_pair,
void *opts ); int slk_attroff(
const chtype attrs ); int slk_attron(
const chtype attrs ); int slk_attrset(
const chtype attrs ); int slk_clear(
void ); int slk_color(
short color_pair ); int slk_init(
int fmt ); char *slk_label(
int labnum ); int slk_noutrefresh(
void ); int slk_refresh(
void ); int slk_restore(
void ); int slk_set(
int labnum,
const char *label,
int fmt ); int slk_wset(
int labnum,
const wchar_t *label,
int fmt ); int slk_touch(
void );
Curses Library (libcurses)
Interfaces documented on this reference page conform to
industry standards as follows:
slk_attr_off, slk_attr_on, slk_attr_set, slk_attroff,
slk_attron, slk_attrset, slk_clear, slk_init, slk_label,
slk_noutrefresh, slk_refresh, slk_restore, slk_set,
slk_wset, slk_touch: XCURSES4.2
Refer to the standards(5) reference page for more information
about industry standards and associated tags.
Curses manipulates the set of soft function-key labels
that exist on many terminals. For those terminals that do
not support soft labels, Curses takes over the bottom line
of stdscr, reducing the size of stdscr and the variable
LINES. Curses standardizes eight labels of up to eight
characters each.
To use soft labels, applications must call the slk_init
routine before calling initscr or newterm. If initscr
eventually uses a line from stdscr to emulate the soft
labels, then fmt determines how the labels are arranged on
the screen. Setting fmt to different values indicates the
label arrangement as follows: Indicates a 3-2-3 arrangement.
Indicates a 4-4 arrangement.
The slk_set and slk_wset routines specify the text of a
soft label. The labnum parameter is the label number, with
values from 1 to 8. The label parameter contains the
string, up to 8 characters in length, to be put on the
label. A null string or a null pointer sets up a blank
label. The fmt parameter can have the values 0, 1, or 2,
to indicate whether the label text is left-justified, centered,
or right-justified, respectively, within the label.
The slk_refresh and slk_noutrefresh routines correspond to
the wrefresh and wnoutrefresh routines but affect labels
rather than windows.
The slk_label function returns the current label text,
stripped of leading and trailing blanks, for the label
number labnum.
The slk_clear function clears the soft labels from the
screen.
The slk_restore function restores the soft labels to the
screen after an slk_clear operation is performed.
The slk_touch function forces all the soft labels to be
output the next time a slk_noutrefresh operation is performed.
The slk_attron, slk_attrset, and slk_attroff routines correspond
to attron, attrset, and attroff, respectively, but
have an effect only if soft labels are simulated on the
bottom line of the screen.
The slk_attr_off, slk_attr_on, and slk_attr_set routines
correspond to attr_off, attr_on, and attr_set, respectively,
but support the attribute constants with the WA_
prefix. The opts argument is reserved for future use.
Currently, the application must provide a null pointer as
opts.
The slk_color routine corresponds to color_set but has an
effect only if soft labels are simulated on the bottom
line of the screen.
The header file <curses.h> automatically includes the
header file <stdio.h>.
Most applications use slk_noutrefresh because wrefresh is
likely to follow soon.
Since the number of columns that a wide-character string
occupies is codeset specific, applications call wcwidth
and wcswidth to check the number of column positions in
the string before calling slk_wset.
Routines that return an integer return ERR upon failure
and OK upon successful completion.
The slk_label routine returns NULL on error.
Functions: curses(3), curs_attr(3), curs_attr_get(3),
curs_initscr(3), curs_refresh(3)
Others: standards(5)
curs_slk(3)
[ Back ] |
