X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_outopts.3x.html;h=d6f6b7d66d391d61aa8888be37822d2ec9da3d74;hb=02f02dcd4464143580e783ae32c822d8eb8cdcbf;hp=c7c345884d4771d2b4aafee66706871270a6c7f8;hpb=cef50b3afcd58166f3541b701c97bce538844c76;p=ncurses.git diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html index c7c34588..d6f6b7d6 100644 --- a/doc/html/man/curs_outopts.3x.html +++ b/doc/html/man/curs_outopts.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_outopts(3x) curs_outopts(3x)-
+NAME
clearok, idlok, idcok, immedok, leaveok, setscrreg, wsetscrreg, scrollok, nl, nonl - curses output options-SYNOPSIS
+SYNOPSIS
#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 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
+DESCRIPTION
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- tions off before calling endwin. + ++clearok
If clearok is called with TRUE as argument, the next call to wrefresh with this window will clear the screen com- pletely and redraw the entire screen from scratch. This @@ -83,6 +86,9 @@ the next call to wrefresh with any window causes the screen to be cleared and repainted from scratch. + ++idlok
If idlok is called with TRUE as second argument, curses considers using the hardware insert/delete line feature of terminals so equipped. Calling idlok with FALSE as second @@ -95,6 +101,9 @@ not be used, curses redraws the changed portions of all lines. + ++idcok
If idcok is called with FALSE as second argument, curses no longer considers using the hardware insert/delete char- acter feature of terminals so equipped. Use of character @@ -102,6 +111,9 @@ TRUE as second argument re-enables use of character inser- tion and deletion. + ++immedok
If immedok is called with TRUE as argument, any change in the window image, such as the ones caused by waddch, wclr- tobot, wscrl, etc., automatically cause a call to wre- @@ -109,12 +121,18 @@ due to repeated calls to wrefresh. It is disabled by de- fault. + ++leaveok
Normally, the hardware cursor is left at the location of the window cursor being refreshed. The leaveok option al- lows the cursor to be left wherever the update happens to leave it. It is useful for applications where the cursor is not used, since it reduces the need for cursor motions. + ++setscrreg
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 @@ -130,6 +148,9 @@ 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 @@ -140,6 +161,9 @@ scrolling effect on the terminal, it is also necessary to call idlok). + ++nl, nonl
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 @@ -153,12 +177,12 @@-RETURN VALUE
+RETURN VALUE
The functions setscrreg and wsetscrreg return OK upon suc- cess and ERR upon failure. All other routines that return an integer always return OK. - X/Open does not define any error conditions. + X/Open Curses 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 @@ -177,7 +201,7 @@-PORTABILITY
+PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. @@ -207,7 +231,7 @@-NOTES
+NOTES
Note that clearok, leaveok, scrollok, idcok, nl, nonl and setscrreg may be macros. @@ -216,19 +240,36 @@-SEE ALSO
- curses(3x), curs_addch(3x), curs_clear(3x), - curs_initscr(3x), curs_scroll(3x), curs_refresh(3x), +SEE ALSO
+ curses(3x), curs_addch(3x), curs_clear(3x), + curs_initscr(3x), curs_scroll(3x), curs_refresh(3x), curs_variables(3x). curs_outopts(3x)-
- -Man(1) output converted with -man2html - +