curs_outopts(S-osr5)

curs_outopts: clearok, idlok, idcok immedok, leaveok, setscrreg, wsetscrreg, scrollok, nl, nonl -- curses routines that control terminal output options

Syntax

cc ... -lcurses

#include <curses.h>

int clearok(WINDOW *win, bool bf);
int idlok(WINDOW *win, bool bf);
void idcok(WINDOW *win, bool bf);
void immedok(WINDOW *win, bool bf);
int leaveok(WINDOW *win, bool bf);
int setscrreg(int top, int bot);
int wsetscrreg(WINDOW *win, int top, int bot);
int scrollok(WINDOW *win, bool bf);
int nl(void);
int nonl(void);

Description

These routines set options that deal with output within curses(S-osr5). All options are initially FALSE, unless otherwise stated. It is not necessary to turn these options off before calling endwin(S-osr5).

clearok

With the clearok(S-osr5) routine, if enabled (bf is TRUE), the next call to wrefresh(S-osr5) for this window clears the screen completely and redraws the entire screen from scratch. This is useful when the contents of the screen are uncertain, or in some cases for a more pleasing visual effect. If the win argument to clearok( ) is the global variable curscr, the next call to wrefresh( ) with any window causes the screen to be cleared and repainted from scratch.

idlok

With the idlok(S-osr5) routine, if enabled (bf is TRUE), curses( ) considers using the hardware insert/delete line feature of terminals so equipped. If disabled (bf is FALSE), curses( ) very seldom uses this feature. (The insert/delete character feature is always considered.) This option should be enabled only if the application needs insert/delete line, for example, for a screen editor. It is disabled by default because insert/delete line tends to be visually annoying when used in applications where it isn't really needed. If insert/delete line cannot be used, curses( ) redraws the changed portions of all lines.

idcok

With the idcok(S-osr5) routine, if enabled (bf is TRUE), curses( ) considers using the hardware insert/delete character feature of terminals so equipped. This is enabled by default.

immedok

With the immedok(S-osr5) routine, if enabled (bf is TRUE), any change in the window image, such as the ones caused by waddch( ), wclrtobot( ), wscrl( ), and so on, automatically cause a call to wrefresh( ). However, these repeated calls to wrefresh( ) can degrade the performance considerably. It is disabled by default.

Normally, the hardware cursor is left at the location of the window cursor being refreshed.

leaveok

The leaveok( ) option leaves the cursor wherever the update happens to leave it. It is useful for applications where the cursor is not used, since it reduces cursor motions. If possible, the cursor is made invisible when this option is enabled.

setscrreg and wsetscrreg

The routines setscrreg(S-osr5) and wsetscrreg(S-osr5) allow the application programmer to set a software scrolling region in a window. top and bot are the line numbers of the top and bottom margin of the scrolling region. (Line 0 is the top line of the window.) If this option and scrollok(S-osr5) are enabled, an attempt to move off the bottom margin line causes all lines in the scrolling region to scroll up one line. Only the text of the window is scrolled. (This has nothing to do with the use of a physical scrolling region capability in the terminal, like that in the VT100. If idlok( ) is enabled and the terminal has either a scrolling region or insert/delete line capability, they will probably be used by the output routines.)

scrollok

The scrollok( ) option controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last line. If disabled, (bf is FALSE), the cursor is left on the bottom line. If enabled, (bf is TRUE), wrefresh( ) is called on the window, and the physical terminal and window are scrolled up one line. To get the physical scrolling effect on the terminal, you must also call idlok( ).

nl and nonl

The nl(S-osr5) and nonl(S-osr5) routines control whether newline is translated into carriage return and linefeed on output, and whether return is translated into newline on input. Initially, the translations do occur. By disabling these translations using nonl( ), curses( ) is able to make better use of the linefeed capability, resulting in faster cursor motion.

Return values

setscrreg( ) and wsetscrreg( ) return OK on success and ERR on failure. All other routines that return an integer always return OK.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: clearok( ), leaveok( ), scrollok( ), idcok( ), nl( ), nonl( ) and setscrreg( ).

The immedok( ) routine is useful for windows that are used as terminal emulators.

Files

/usr/lib/libcurses.a: the library

Standards conformance

clearok(S-osr5), idlok(S-osr5), leaveok(S-osr5), setscrreg(S-osr5), wsetscrreg(S-osr5), scrollok(S-osr5), nl(S-osr5), idcok(S-osr5), immedok(S-osr5), and nonl(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.