diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_outopts.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/curs_outopts.3x.html | 188 |
1 files changed, 0 insertions, 188 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_outopts.3x.html b/ncurses-5.2/doc/html/man/curs_outopts.3x.html deleted file mode 100644 index a7a0a45..0000000 --- a/ncurses-5.2/doc/html/man/curs_outopts.3x.html +++ /dev/null @@ -1,188 +0,0 @@ -<HTML> -<BODY> -<PRE> -<!-- Manpage converted by man2html 3.0.1 --> - -</PRE> -<H2>NAME</H2><PRE> - <B>clearok</B>, <B>idlok</B>, <B>idcok</B> <B>immedok</B>, <B>leaveok</B>, <B>setscrreg</B>, - <B>wsetscrreg</B>, <B>scrollok</B>, <B>nl</B>, <B>nonl</B> - <B>curses</B> output options - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <B>#include</B> <B><curses.h></B> - - <B>int</B> <B>clearok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>int</B> <B>idlok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>void</B> <B>idcok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>void</B> <B>immedok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>int</B> <B>leaveok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>int</B> <B>setscrreg(int</B> <B>top,</B> <B>int</B> <B>bot);</B> - <B>int</B> <B>wsetscrreg(WINDOW</B> <B>*win,</B> <B>int</B> <B>top,</B> <B>int</B> <B>bot);</B> - <B>int</B> <B>scrollok(WINDOW</B> <B>*win,</B> <B>bool</B> <B>bf);</B> - <B>int</B> <B>nl(void);</B> - <B>int</B> <B>nonl(void);</B> - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - These routines set options that change the style of output - within <B>curses</B>. All options are initially <B>FALSE</B>, unless - otherwise stated. It is not necessary to turn these - options off before calling <B>endwin</B>. - - If <B>clearok</B> is called with <B>TRUE</B> as argument, the next call - to <B>wrefresh</B> with this window will clear the screen com- - pletely and redraw 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 <I>win</I> argument to <B>clearok</B> is the global variable <B>curscr</B>, - the next call to <B>wrefresh</B> with any window causes the - screen to be cleared and repainted from scratch. - - If <B>idlok</B> is called with <B>TRUE</B> as second argument, <B>curses</B> - considers using the hardware insert/delete line feature of - terminals so equipped. Calling <B>idlok</B> with <B>FALSE</B> as second - argument disables use of line insertion and deletion. - This option should be enabled only if the application - needs insert/delete line, for example, for a screen edi- - tor. 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 can- - not be used, <B>curses</B> redraws the changed portions of all - lines. - - If <B>idcok</B> is called with <B>FALSE</B> as second argument, <B>curses</B> - no longer considers using the hardware insert/delete char- - acter feature of terminals so equipped. Use of character - insert/delete is enabled by default. Calling <B>idcok</B> with - <B>TRUE</B> as second argument re-enables use of character inser- - tion and deletion. - - If <B>immedok</B> is called with <B>TRUE</B> <B>as</B> <B>argument</B>, any change in - the window image, such as the ones caused by <B>waddch,</B> - <B>wclrtobot,</B> <B>wscrl</B>, <I>etc</I>., automatically cause a call to <B>wre-</B> - <B>fresh</B>. However, it may degrade performance considerably, - due to repeated calls to <B>wrefresh</B>. It is disabled by - default. - - Normally, the hardware cursor is left at the location of - the window cursor being refreshed. The <B>leaveok</B> option - allows the cursor to be left wherever the update happens - to leave it. It is useful for applications where the cur- - sor is not used, since it reduces the need for cursor - motions. If possible, the cursor is made invisible when - this option is enabled. - - The <B>setscrreg</B> and <B>wsetscrreg</B> routines allow the applica- - tion programmer to set a software scrolling region in a - window. <I>top</I> and <I>bot</I> 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 <B>scrollok</B> are - enabled, an attempt to move off the bottom 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 region capability in - the terminal, like that in the VT100. If <B>idlok</B> 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 <B>scrollok</B> 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, (<I>bf</I> is <B>FALSE</B>), the cursor is left - on the bottom line. If enabled, (<I>bf</I> is <B>TRUE</B>), the window - is scrolled up one line (Note that in order to get the - physical scrolling effect on the terminal, it is also nec- - essary to call <B>idlok</B>). - - The <B>nl</B> and <B>nonl</B> 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 <B>addch('\n')</B> - does the equivalent of return and line feed on the virtual - screen). Initially, these translations do occur. If you - disable them using <B>nonl</B>, <B>curses</B> will be able to make bet- - ter use of the line-feed capability, resulting in faster - cursor motion. Also, <B>curses</B> will then be able to detect - the return key. - - -</PRE> -<H2>RETURN VALUE</H2><PRE> - The functions <B>setscrreg</B> and <B>wsetscrreg</B> return <B>OK</B> upon suc- - cess and <B>ERR</B> upon failure. All other routines that return - an integer always return <B>OK</B>. - - -</PRE> -<H2>PORTABILITY</H2><PRE> - These functions are described in the XSI Curses standard, - Issue 4. - - The XSI Curses standard is ambiguous on the question of - whether <B>raw</B>() should disable the CRLF translations con- - trolled by <B>nl</B>() and <B>nonl</B>(). BSD curses did turn off these - translations; AT&T curses (at least as late as SVr1) did - not. We choose to do so, on the theory that a programmer - requesting raw input wants a clean (ideally 8-bit clean) - connection that the operating system does not mess with. - - Some historic curses implementations had, as an undocu- - mented feature, the ability to do the equivalent of - <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B> or <B>clear(std-</B> - <B>scr)</B>. This will not work under ncurses. - - Earlier System V curses implementations specified that - with <B>scrollok</B> enabled, any window modification triggering - a scroll also forced a physical refresh. XSI Curses does - not require this, and <B>ncurses</B> avoids doing it in order to - perform better vertical-motion optimization at <B>wrefresh</B> - time. - - The XSI Curses standard does not mention that the cursor - should be made invisible as a side-effect of <B>leaveok</B>. - SVr4 curses documentation does this, but the code does - not. Use <B>curs_set</B> to make the cursor invisible. - - -</PRE> -<H2>NOTES</H2><PRE> - Note that <B>clearok</B>, <B>leaveok</B>, <B>scrollok</B>, <B>idcok</B>, <B>nl</B>, <B>nonl</B> and - <B>setscrreg</B> may be macros. - - The <B>immedok</B> routine is useful for windows that are used as - terminal emulators. - - -</PRE> -<H2>SEE ALSO</H2><PRE> - <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_addch.3x.html">curs_addch(3x)</A></B>, <B><A HREF="curs_clear.3x.html">curs_clear(3x)</A></B>, - <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> - - - - - - - - - - - - - - - -</PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> -</BODY> -</HTML> |