These routines set options that change the style of output
within curses. All options are initially FALSE, unless
otherwise stated. It is not necessary to turn these op-
@@ -115,45 +116,45 @@
leave it. It is useful for applications where the cursor
is not used, since it reduces the need for cursor motions.
- The setscrreg and wsetscrreg routines allow the applica-
- tion 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 are en-
- abled, an attempt to move off the bottom margin line caus-
- es all lines in the scrolling region to scroll one line in
- the direction of the first line. Only the text of the
- window is scrolled. (Note that 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 in-
- sert/delete line capability, they will probably be used by
- the output routines.)
-
- 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
+ The setscrreg and wsetscrreg routines allow the applica-
+ tion programmer to set a software scrolling region in a
+ window. The top and bot parameters 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 are enabled, an attempt to move off the bot-
+ tom margin line causes all lines in the scrolling region
+ to scroll one line in the direction of the first line.
+ Only the text of the window is scrolled. (Note that this
+ has nothing to do with the use of a physical scrolling re-
+ gion 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.)
+
+ 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), the window
- is scrolled up one line (Note that to get the physical
- scrolling effect on the terminal, it is also necessary to
+ on the bottom line. If enabled, (bf is TRUE), the window
+ is scrolled up one line (Note that to get the physical
+ scrolling effect on the terminal, it is also necessary to
call idlok).
- The nl and nonl routines control whether the underlying
- display device translates the return key into newline on
- input, and whether it translates newline into return and
- line-feed on output (in either case, the call addch('\n')
+ The nl and nonl routines control whether the underlying
+ display device translates the return key into newline on
+ input, and whether it translates newline into return and
+ line-feed on output (in either case, the call addch('\n')
does the equivalent of return and line feed on the virtual
- screen). Initially, these translations do occur. If you
- disable them using nonl, curses will be able to make bet-
- ter use of the line-feed capability, resulting in faster
- cursor motion. Also, curses will then be able to detect
+ screen). Initially, these translations do occur. If you
+ disable them using nonl, curses will be able to make bet-
+ ter use of the line-feed capability, resulting in faster
+ cursor motion. Also, curses will then be able to detect
the return key.
The functions setscrreg and wsetscrreg return OK upon suc-
cess and ERR upon failure. All other routines that return
an integer always return OK.
@@ -161,23 +162,23 @@
X/Open does not define any error conditions.
In this implementation, those functions that have a window
- pointer will return an error if the window pointer is
+ pointer will return an error if the window pointer is
null.
wclrtoeol
- returns an error if the cursor position is
+ returns an error if the cursor position is
about to wrap.
wsetscrreg
- returns an error if the scrolling region lim-
+ returns an error if the scrolling region lim-
its extend outside the window.
- X/Open does not define any error conditions. This imple-
- mentation returns an error if the window pointer is null.
+ X/Open does not define any error conditions. This imple-
+ mentation returns an error if the window pointer is null.