1999-10-24 12:32:42 +08:00
|
|
|
.\"***************************************************************************
|
2004-02-09 10:15:26 +08:00
|
|
|
.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
|
1999-10-24 12:32:42 +08:00
|
|
|
.\" *
|
|
|
|
|
.\" 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. *
|
|
|
|
|
.\"***************************************************************************
|
|
|
|
|
.\"
|
2004-02-09 10:15:26 +08:00
|
|
|
.\" $Id: curs_initscr.3x,v 1.12 2003/05/10 20:33:49 jmc Exp $
|
1997-05-15 12:00:00 +08:00
|
|
|
.TH curs_initscr 3X ""
|
|
|
|
|
.SH NAME
|
2000-07-09 10:46:08 +08:00
|
|
|
\fBinitscr\fR,
|
|
|
|
|
\fBnewterm\fR,
|
|
|
|
|
\fBendwin\fR,
|
|
|
|
|
\fBisendwin\fR,
|
|
|
|
|
\fBset_term\fR,
|
|
|
|
|
\fBdelscreen\fR - \fBcurses\fR screen initialization and manipulation routines
|
1997-05-15 12:00:00 +08:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
\fB#include <curses.h>\fR
|
|
|
|
|
|
|
|
|
|
\fBWINDOW *initscr(void);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint endwin(void);\fR
|
|
|
|
|
.br
|
2000-07-09 10:46:08 +08:00
|
|
|
\fBbool isendwin(void);\fR
|
1997-05-15 12:00:00 +08:00
|
|
|
.br
|
2002-10-13 11:35:53 +08:00
|
|
|
\fBSCREEN *newterm(char *type, FILE *outfd, FILE *infd);\fR
|
1997-05-15 12:00:00 +08:00
|
|
|
.br
|
|
|
|
|
\fBSCREEN *set_term(SCREEN *new);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBvoid delscreen(SCREEN* sp);\fR
|
|
|
|
|
.br
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
\fBinitscr\fR is normally the first \fBcurses\fR routine to call when
|
|
|
|
|
initializing a program. A few special routines sometimes need to be
|
|
|
|
|
called before it; these are \fBslk_init\fR, \fBfilter\fR, \fBripoffline\fR,
|
|
|
|
|
\fBuse_env\fR. For multiple-terminal applications, \fBnewterm\fR may be
|
|
|
|
|
called before \fBinitscr\fR.
|
|
|
|
|
|
|
|
|
|
The initscr code determines the terminal type and initializes all \fBcurses\fR
|
|
|
|
|
data structures. \fBinitscr\fR also causes the first call to \fBrefresh\fR to
|
|
|
|
|
clear the screen. If errors occur, \fBinitscr\fR writes an appropriate error
|
|
|
|
|
message to standard error and exits; otherwise, a pointer is returned to
|
|
|
|
|
\fBstdscr\fR.
|
|
|
|
|
|
|
|
|
|
A program that outputs to more than one terminal should use the \fBnewterm\fR
|
|
|
|
|
routine for each terminal instead of \fBinitscr\fR. A program that needs to
|
|
|
|
|
inspect capabilities, so it can continue to run in a line-oriented mode if the
|
|
|
|
|
terminal cannot support a screen-oriented program, would also use
|
|
|
|
|
\fBnewterm\fR. The routine \fBnewterm\fR should be called once for each
|
|
|
|
|
terminal. It returns a variable of type \fBSCREEN *\fR which should be saved
|
|
|
|
|
as a reference to that terminal. The arguments are the \fItype\fR of the
|
|
|
|
|
terminal to be used in place of \fB$TERM\fR, a file pointer for output to the
|
|
|
|
|
terminal, and another file pointer for input from the terminal (if \fItype\fR
|
|
|
|
|
is \fBNULL\fR, \fB$TERM\fR will be used). The program must also call
|
|
|
|
|
\fBendwin\fR for each terminal being used before exiting from \fBcurses\fR.
|
|
|
|
|
If \fBnewterm\fR is called more than once for the same terminal, the first
|
|
|
|
|
terminal referred to must be the last one for which \fBendwin\fR is called.
|
|
|
|
|
|
|
|
|
|
A program should always call \fBendwin\fR before exiting or escaping from
|
|
|
|
|
\fBcurses\fR mode temporarily. This routine restores tty modes, moves the
|
|
|
|
|
cursor to the lower left-hand corner of the screen and resets the terminal into
|
|
|
|
|
the proper non-visual mode. Calling \fBrefresh\fR or \fBdoupdate\fR after a
|
|
|
|
|
temporary escape causes the program to resume visual mode.
|
|
|
|
|
|
|
|
|
|
The \fBisendwin\fR routine returns \fBTRUE\fR if \fBendwin\fR has been
|
|
|
|
|
called without any subsequent calls to \fBwrefresh\fR, and \fBFALSE\fR
|
|
|
|
|
otherwise.
|
|
|
|
|
|
|
|
|
|
The \fBset_term\fR routine is used to switch between different
|
|
|
|
|
terminals. The screen reference \fBnew\fR becomes the new current
|
|
|
|
|
terminal. The previous terminal is returned by the routine. This is
|
|
|
|
|
the only routine which manipulates \fBSCREEN\fR pointers; all other
|
|
|
|
|
routines affect only the current terminal.
|
|
|
|
|
|
|
|
|
|
The \fBdelscreen\fR routine frees storage associated with the
|
|
|
|
|
\fBSCREEN\fR data structure. The \fBendwin\fR routine does not do
|
|
|
|
|
this, so \fBdelscreen\fR should be called after \fBendwin\fR if a
|
|
|
|
|
particular \fBSCREEN\fR is no longer needed.
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
\fBendwin\fR returns the integer \fBERR\fR upon failure and \fBOK\fR
|
|
|
|
|
upon successful completion.
|
|
|
|
|
|
|
|
|
|
Routines that return pointers always return \fBNULL\fR on error.
|
|
|
|
|
.SH NOTES
|
|
|
|
|
Note that \fBinitscr\fR and \fBnewterm\fR may be macros.
|
|
|
|
|
.SH PORTABILITY
|
|
|
|
|
These functions are described in the XSI Curses standard, Issue 4. It
|
|
|
|
|
specifies that portable applications must not call \fBinitscr\fR more than
|
|
|
|
|
once.
|
1999-10-24 12:32:42 +08:00
|
|
|
|
|
|
|
|
Old versions of curses, e.g., BSD 4.4, may have returned a null pointer
|
|
|
|
|
from \fBinitscr\fR when an error is detected, rather than exiting.
|
2004-02-09 10:15:26 +08:00
|
|
|
It is safe but redundant to check the return value of \fBinitscr\fR
|
1999-10-24 12:32:42 +08:00
|
|
|
in XSI Curses.
|
1997-05-15 12:00:00 +08:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
\fBcurses\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_refresh\fR(3X),
|
|
|
|
|
\fBcurs_slk\fR(3X), \fBcurs_util\fR(3X)
|
|
|
|
|
.\"#
|
|
|
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
|
|
|
.\"# Local Variables:
|
|
|
|
|
.\"# mode:nroff
|
|
|
|
|
.\"# fill-column:79
|
|
|
|
|
.\"# End:
|
