Tribblix: manual page: slk

SLK_ATTROFF(3XCURSES) X/Open Curses Library Functions SLK_ATTROFF(3XCURSES)

NAME

slk_attroff, slk_attr_off, slk_attron, slk_attr_on, slk_attrset,
slk_attr_set, slk_clear, slk_color, slk_init, slk_label,
slk_noutrefresh, slk_refresh, slk_restore, slk_set, slk_touch,
slk_wset - soft label functions

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int slk_attroff(const chtype attrs);

int slk_attr_off(const attr_t attrs, void *opts);

int slk_attron(const chtype attrs);

int slk_attr_on(const attr_t attrs, void *opts);

int slk_attrset(const chtype attrs);

int slk_attr_set(const attr_t attrs, short color_pair_number, void *opts);

int slk_clear(void);

int slk_color(short color_pair_number);

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

int slk_touch(void);

int slk_wset(int labnum, const wchar_t *label, int justify);

PARAMETERS

attrs
are the window attributes to be added or
removed.

opts
Is reserved for future use. Currently, this must
be a null pointer.

color_pair_number
Is a color pair.

fmt
Is the format of how the labels are arranged on
the screen.

labnum
Is the number of the soft label.

label
Is the name to be given to a soft label.

justify
Is a number indicating how to justify the label
name.

DESCRIPTION

The Curses interface manipulates the set of soft function-key labels
that exist on many terminals. For those terminals that do not have
soft labels, Curses takes over the bottom line of stdscr, reducing
the size of stdscr and the value of the LINES external variable.
There can be up to eight labels of up to eight display columns each.

To use soft labels, slk_init() must be called before calling
initscr(3XCURSES), newterm(3XCURSES), or ripoffline(3XCURSES). 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 0 indicates a 3-2-3 arrangement of the labels;
1 indicates a 4-4 arrangement. Other values for fmt are unspecified.

The slk_init() function has the effect of calling ripoffline() to
reserve one screen line to accommodate the requested format.

The slk_set() and slk_wset() functions specify the text of soft label
number labnum, within the range from 1 to and including 8. The label
argument is the string to be put the lable. With slk_set() and
slk_wset(), the width of the label is limited to eight columns
positions. A null string or a null pointer specifies a blank label.
The justify argument can have the following values to indicate how to
justify label within the space reserved for it:

0
Align the start of label with the start of the space

1
Center label within the space

2
Align the end of label with the end of the space

The slk_refresh() and slk_noutrefresh() functions correspond to the
wrefresh(3XCURSES) and wnoutrefresh(3XCURSES) functions.

The slk_label() function obtains soft label number labnum.

The slk_clear() function immediately clears the soft labels from the
screen.

The slk_restore() function immediately restores the soft labels to
the screen after a call to slk_clear().

The slk_touch() function forces all the soft labels to be output the
next time slk_refresh() or slk_noutrefresh() is called.

The slk_attron(), slk_attrset(), and slk_attroff() functions
correspond to the attron(3XCURSES), attrset(3XCURSES), and
attroff(3XCURSES) functions. They have an effect only if soft labels
are stimulated on the bottom line of the screen.

The slk_attr_on(), slk_attr_off(), slk_attr_set() and slk_color()
functions correspond to the attr_on(3XCURSES), attr_off(3XCURSES),
attr_set(3XCURSES), and color_set(3XCURSES) functions. As a result,
they support color and the attribute constants with the WA_ prefix.

The opts argument is reserved for definition in a future release.
Currently, the opts argument is a null pointer.

RETURN VALUES

Upon successful completion, the slk_label() function returns the
requested label with leading and trailing blanks stripped. Otherwise,
it returns a null pointer.

Upon successful completion, the other functions return OK.
Otherwise, they return ERR.

ERRORS

No errors are defined.

USAGE

When using multi-byte character sets, applications should check the
width of the string by calling mbstowcs(3C) and then wcswidth(3C)
before calling slk_set(). When using wide characters, applications
should check the width of the string by calling wcswidth() before
calling slk_set().

Since the number of columns that a wide string will occupy is
codeset-specific, call wcwidth(3C) and wcswidth(3C) to check the
number of column positions in the string before calling slk_wset().

Most applications would use slk_noutrefresh() because a wrefresh()
is likely to follow soon.

ATTRIBUTES