HP-UX Reference (11i v2 07/12) - 3 Library Functions A-M (vol 6)

ManualsBrandsHP ManualsSoftwareHP-UX Reference Manuals

181

182

183

184

185

186

187

188

189

190

clearok(3X) clearok(3X)

(CURSES)

NAME

clearok(), idlok(), leaveok(), scrollok(), setscrreg(), wsetscrreg() - terminal output control functions

SYNOPSIS

#include <curses.h>

int clearok(WINDOW *

win, bool bf);

int idlok(WINDOW *

win, bool bf);

int leaveok(WINDOW *

win, bool bf);

int scrollok(WINDOW *

win, bool bf);

int setscrreg(int

top, int bot);

int wsetscrreg(WINDOW *

win, int top, int

bot);

DESCRIPTION

These functions set options that deal with output within Curses.

The clearok() function assigns the value of bf to an internal ﬂag in the speciﬁed window that governs

clearing of the screen during a refresh. If, during a refresh operation on the speciﬁed window, the ﬂag in

curscr is TRUE or the ﬂag in the speciﬁed window is TRUE, then the implementation clears the screen,

redraws it in its entirety, and sets the ﬂag to FALSE in curscr and in the speciﬁed window. The initial

state is unspeciﬁed.

The

idlok() function speciﬁes whether the implementation may use the hardware insert-line, delete-

line, and scroll features of terminals so equipped. If bf is TRUE, use of these features is enabled. If bf is

FALSE, use of these features is disabled and lines are instead redrawn as required. The initial state is

FALSE.

The

leaveok() function controls the cursor position after a refresh operation. If bf is TRUE, refresh

operations on the speciﬁed window may leave the terminal’s cursor at an arbitrary position. If bf is FALSE,

then at the end of any refresh operation, the terminal’s cursor is positioned at the cursor position contained

in the speciﬁed window. The initial state is FALSE.

The

scrollok() function controls the use of scrolling. If bf is TRUE, then scrolling is enabled for the

speciﬁed window, with the consequences discussed in Truncation, Wrapping and Scrolling in

curses_intro(3X). If bf is FALSE, scrolling is disabled for the speciﬁed window. The initial state is FALSE.

The

setscrreg() and wsetscrreg() functions deﬁne a software scrolling region in the current or

speciﬁed window. The top and bot arguments are the line numbers of the ﬁrst and last line deﬁning the

scrolling region. (Line 0 is the top line of the window.) If this option and scrollok()

are enabled, an

attempt to move off the last line of the margin causes all lines in the scrolling region to scroll one line in the

direction of the ﬁrst line. Only characters in the window are scrolled. If a software scrolling region is set

and

scrollok() is not enabled, an attempt to move off the last line of the margin does not reposition

any lines in the scrolling region.

Application Usage

The only reason to enable the idlok() feature is to use scrolling to achieve the visual effect of motion of a

partial window, such as for a screen editor. In other cases, the feature can be visually annoying.

The leaveok() option provides greater efﬁciency for applications that do not use the cursor.

RETURN VALUE

Upon successful completion, setscrreg() and wsetscrreg() return OK. Otherwise, they return

ERR.

The other functions always return OK.

ERRORS

No errors are deﬁned.