curs_slk(3X) UNIX System V curs_slk(3X)
NAME
cursslk: slkinit, slkset, slkrefresh, slknoutrefresh, slklabel,
slkclear, slkrestore, slktouch, slkattron, slkattrset, slkattroff -
curses soft label routines
SYNOPSIS
#include <curses.h>
int slkinit(int fmt);
int slkset(int labnum, char *label, int fmt);
int slkrefresh(void);
int slknoutrefresh(void);
char *slklabel(int labnum);
int slkclear(void);
int slkrestore(void);
int slktouch(void);
int slkattron(chtype attrs);
int slkattrset(chtype attrs);
int slkattroff(chtype attrs);
DESCRIPTION
curses 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
variable LINES. curses standardizes on eight labels of up to eight
characters each.
To use soft labels, the slkinit routine must be called before initscr or
newterm is called. 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.
With the slkset routine, labnum is the label number, from 1 to 8. label
is the string to be put on the label, up to eight characters in length.
A null string or a null pointer sets up a blank label. fmt is either 0,
1, or 2, indicating whether the label is to be left-justified, centered,
or right-justified, respectively, within the label.
The slkrefresh and slknoutrefresh routines correspond to the wrefresh
and wnoutrefresh routines.
With the slklabel routine, the current label for label number labnum is
returned with leading and trailing blanks stripped.
With the slkclear routine, the soft labels are cleared from the screen.
With the slkrestore routine, the soft labels are restored to the screen
after a slkclear is performed.
10/89 Page 1
curs_slk(3X) UNIX System V curs_slk(3X)
With the slktouch routine, all the soft labels are forced to be output
the next time a slknoutrefresh is performed.
The slkattron, slkattrset and slkattroff routines correspond to
attron, attrset, and attroff. They have an effect only if soft labels
are simulated on the bottom line of the screen.
RETURN VALUE
Routines that return an integer return ERR upon failure and an integer
value other than ERR upon successful completion.
slklabel returns NULL on error.
NOTES
The header file <curses.h> automatically includes the header files
<stdio.h> and <unctrl.h>.
Most applications would use slknoutrefresh because a wrefresh is likely
to follow soon.
SEE ALSO
curses(3X), cursattr(3X), cursinitscr(3X), cursrefresh(3X)
Page 2 10/89