-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The slk* functions manipulate the set of soft function-key
- labels that exist on many terminals. For those terminals
- that do not have soft labels, <B>curses</B> takes over the bottom
- line of <B>stdscr</B>, reducing the size of <B>stdscr</B> and the vari-
- able <B>LINES</B>. <B>curses</B> standardizes on eight labels of up to
- eight characters each. In addition to this, the ncurses
- implementation supports a mode where it simulates 12
- labels of up to five characters each. This is most common
- for todays PC like enduser devices. Please note that
- ncurses simulates this mode by taking over up to two lines
- at the bottom of the screen, it doesn't try to use any
- hardware support for this mode.
-
- The <B>slk_init</B> routine must be called before <B>initscr</B> or
- <B>newterm</B> is called. If <B>initscr</B> eventually uses a line from
- <B>stdscr</B> to emulate the soft labels, then <I>fmt</I> determines how
- the labels are arranged on the screen. Setting <I>fmt</I> to <B>0</B>
- indicates a 3-2-3 arrangement of the labels, <B>1</B> indicates a
- 4-4 arrangement and <B>2</B> indicates the PC like 4-4-4 mode. If
- <B>fmt</B> is set to <B>3</B>, it is again the PC like 4-4-4 mode, but
- in addition an index line is generated, helping the user
- to identify the key numbers easily.
-
- The <B>slk_set</B> routine requires <I>labnum</I> to be a label number,
- from <B>1</B> to <B>8</B> (resp. <B>12</B>); <I>label</I> must be the string to be put
- on the label, up to eight (resp. five) characters in
- length. A null string or a null pointer sets up a blank
- label. <I>fmt</I> is either <B>0</B>, <B>1</B>, or <B>2</B>, indicating whether the
- label is to be left-justified, centered, or right-justi-
- fied, respectively, within the label.
-
- The <B>slk_refresh</B> and <B>slk_noutrefresh</B> routines correspond to
- the <B>wrefresh</B> and <B>wnoutrefresh</B> routines.
-
- The <B>slk_label</B> routine returns the current label for label
- number <I>labnum</I>, with leading and trailing blanks stripped.
-
- The <B>slk_clear</B> routine clears the soft labels from the
- screen.
-
- The <B>slk_restore</B> routine, restores the soft labels to the
- screen after a <B>slk_clear</B> has been performed.
-
- The <B>slk_touch</B> routine forces all the soft labels to be
- output the next time a <B>slk_noutrefresh</B> is performed.
-
- The <B>slk_attron</B>, <B>slk_attrset</B>, <B>slk_attroff</B> and <B>slk_attr</B> rou-
- tines correspond to <B>attron</B>, <B>attrset</B>, <B>attroff</B> and <B>attr_get</B>.
- They have an effect only if soft labels are simulated on
- the bottom line of the screen. The default highlight for
- soft keys is A_STANDOUT (as in System V curses, which does
- not document this fact).
-
- The <B>slk_color</B> routine corresponds to <B>color_set</B>. It has an
- effect only if soft labels are simulated on the bottom
- line of the screen.
projects / ncurses.git / blobdiff