.\"***************************************************************************.\" Copyright (c) 1998-2001,2003 Free Software Foundation, Inc.              *.\"                                                                          *.\" Permission is hereby granted, free of charge, to any person obtaining a  *.\" copy of this software and associated documentation files (the            *.\" "Software"), to deal in the Software without restriction, including      *.\" without limitation the rights to use, copy, modify, merge, publish,      *.\" distribute, distribute with modifications, sublicense, and/or sell       *.\" copies of the Software, and to permit persons to whom the Software is    *.\" furnished to do so, subject to the following conditions:                 *.\"                                                                          *.\" The above copyright notice and this permission notice shall be included  *.\" in all copies or substantial portions of the Software.                   *.\"                                                                          *.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *.\"                                                                          *.\" Except as contained in this notice, the name(s) of the above copyright   *.\" holders shall not be used in advertising or otherwise to promote the     *.\" sale, use or other dealings in this Software without prior written       *.\" authorization.                                                           *.\"***************************************************************************.\".\" $Id: curs_outopts.3x,v 1.18 2003/05/10 20:33:49 jmc Exp $.TH curs_outopts 3X "".SH NAME\fBclearok\fR, \fBidlok\fR, \fBidcok\fR, \fBimmedok\fR,\fBleaveok\fR, \fBsetscrreg\fR, \fBwsetscrreg\fR, \fBscrollok\fR,\fBnl\fR, \fBnonl\fR - \fBcurses\fR output options.SH SYNOPSIS\fB#include <curses.h>\fR\fBint clearok(WINDOW *win, bool bf);\fR.br\fBint idlok(WINDOW *win, bool bf);\fR.br\fBvoid idcok(WINDOW *win, bool bf);\fR.br\fBvoid immedok(WINDOW *win, bool bf);\fR.br\fBint leaveok(WINDOW *win, bool bf);\fR.br\fBint setscrreg(int top, int bot);\fR.br\fBint wsetscrreg(WINDOW *win, int top, int bot);\fR.br\fBint scrollok(WINDOW *win, bool bf);\fR.br\fBint nl(void);\fR.br\fBint nonl(void);\fR.br.SH DESCRIPTIONThese routines set options that change the style of output within\fBcurses\fR.All options are initially \fBFALSE\fR, unless otherwise stated.It is not necessary to turn these options off before calling \fBendwin\fR.If \fBclearok\fR is called with \fBTRUE\fR as argument, the nextcall to \fBwrefresh\fR with this window will clear the screen completely andredraw the entire screen from scratch.This is useful when the contents of thescreen are uncertain, or in some cases for a more pleasing visual effect.Ifthe \fIwin\fR argument to \fBclearok\fR is the global variable \fBcurscr\fR,the next call to \fBwrefresh\fR with any window causes the screen to be clearedand repainted from scratch.If \fBidlok\fR is called with \fBTRUE\fR as second argument, \fBcurses\fRconsiders using the hardware insert/delete line feature of terminals soequipped.Calling \fBidlok\fR with \fBFALSE\fR as second argument disables useof line insertion and deletion.This option should be enabled only if theapplication needs insert/delete line, for example, for a screen editor.It isdisabled by default because insert/delete line tends to be visually annoyingwhen used in applications where it isn't really needed.If insert/delete linecannot be used, \fBcurses\fR redraws the changed portions of all lines.If \fBidcok\fR is called with \fBFALSE\fR as second argument, \fBcurses\fRno longer considers using the hardware insert/delete character feature ofterminals so equipped.Use of character insert/delete is enabled by default.Calling \fBidcok\fR with \fBTRUE\fR as second argument re-enables useof character insertion and deletion.If \fBimmedok\fR is called with \fBTRUE as argument\fR, any changein the window image, such as the ones caused by \fBwaddch, wclrtobot, wscrl\fR,etc., automatically cause a call to \fBwrefresh\fR.However, it maydegrade performance considerably, due to repeated calls to \fBwrefresh\fR.It is disabled by default.Normally, the hardware cursor is left at the location of the window cursorbeing refreshed.The \fBleaveok\fR option allows the cursor to be leftwherever the update happens to leave it.It is useful for applications wherethe cursor is not used, since it reduces the need for cursor motions.The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the applicationprogrammer to set a software scrolling region in a window.\fItop\fR and\fIbot\fR are the line numbers of the top and bottom margin of the scrollingregion.(Line 0 is the top line of the window.)  If this option and\fBscrollok\fR are enabled, an attempt to move off the bottom margin linecauses all lines in the scrolling region to scroll one line in the directionof the first line.Only the text of the window is scrolled.(Note that thishas nothing to do with the use of a physical scrolling region capability in theterminal, like that in the VT100.If \fBidlok\fR is enabled and the terminalhas either a scrolling region or insert/delete line capability, they willprobably be used by the output routines.)The \fBscrollok\fR option controls what happens when the cursor of a window ismoved off the edge of the window or scrolling region, either as a result of anewline action on the bottom line, or typing the last character of the lastline.If disabled, (\fIbf\fR is \fBFALSE\fR), the cursor is left on the bottomline.If enabled, (\fIbf\fR is \fBTRUE\fR), the window is scrolled up one line(Note that to get the physical scrolling effect on the terminal, it isalso necessary to call \fBidlok\fR).The \fBnl\fR and \fBnonl\fR routines control whether the underlying displaydevice translates the return key into newline on input, and whether ittranslates newline into return and line-feed on output (in either case, thecall \fBaddch('\\n')\fR does the equivalent of return and line feed on thevirtual screen).Initially, these translations do occur.If you disable themusing \fBnonl\fR, \fBcurses\fR will be able to make better use of the line-feedcapability, resulting in faster cursor motion.Also, \fBcurses\fR will then beable to detect the return key..SH RETURN VALUEThe functions \fBsetscrreg\fR and \fBwsetscrreg\fR return \fBOK\fR upon successand \fBERR\fR upon failure.All other routines that return an integer alwaysreturn \fBOK\fR..SH PORTABILITYThese functions are described in the XSI Curses standard, Issue 4.The XSI Curses standard is ambiguous on the question of whether \fBraw\fR()should disable the CRLF translations controlled by \fBnl\fR() and \fBnonl\fR().BSD curses did turn off these translations; AT&T curses (at least as late asSVr1) did not.We choose to do so, on the theory that a programmer requestingraw input wants a clean (ideally 8-bit clean) connection that the operatingsystem does not mess with.Some historic curses implementations had, as an undocumented feature, theability to do the equivalent of \fBclearok(..., 1)\fR by saying\fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.This will not work underncurses.Earlier System V curses implementations specified that with \fBscrollok\fRenabled, any window modification triggering a scroll also forced a physicalrefresh.XSI Curses does not require this, and \fBncurses\fR avoids doingit to perform better vertical-motion optimization at \fBwrefresh\fRtime.The XSI Curses standard does not mention that the cursor should bemade invisible as a side-effect of \fBleaveok\fR.SVr4 curses documentation does this, but the code does not.Use \fBcurs_set\fR to make the cursor invisible..SH NOTESNote that \fBclearok\fR, \fBleaveok\fR, \fBscrollok\fR, \fBidcok\fR, \fBnl\fR,\fBnonl\fR and \fBsetscrreg\fR may be macros.The \fBimmedok\fR routine is useful for windows that are used as terminalemulators..SH SEE ALSO\fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_clear\fR(3X),\fBcurs_initscr\fR(3X), \fBcurs_scroll\fR(3X), \fBcurs_refresh\fR(3X).\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: