ncurses 5.6 - patch 20070512
[ncurses.git] / man / curs_opaque.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2007 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_opaque.3x,v 1.3 2007/05/12 17:04:47 tom Exp $
30 .TH curs_opaque 3X ""
31 .na
32 .hy 0
33 .SH NAME
34 \fBis_cleared\fR,
35 \fBis_idlok\fR,
36 \fBis_idcok\fR,
37 \fBis_immedok\fR,
38 \fBis_keypad\fR,
39 \fBis_leaveok\fR,
40 \fBis_nodelay\fR,
41 \fBis_timeout\fR,
42 \fBis_scrollok\fR,
43 \fBis_syncok\fR - \fBcurses\fR output options
44 .ad
45 .hy
46 .SH SYNOPSIS
47 \fB#include <curses.h>\fR
48 .sp
49 \fBbool is_cleared(WINDOW *win);\fR
50 .br
51 \fBbool is_idcok(WINDOW *win);\fR
52 .br
53 \fBbool is_idlok(WINDOW *win);\fR
54 .br
55 \fBbool is_immedok(WINDOW *win);\fR
56 .br
57 \fBbool is_keypad(WINDOW *win);\fR
58 .br
59 \fBbool is_leaveok(WINDOW *win);\fR
60 .br
61 \fBbool is_nodelay(WINDOW *win);\fR
62 .br
63 \fBbool is_notimeout(WINDOW *win);\fR
64 .br
65 \fBbool is_scrollok(WINDOW *win);\fR
66 .br
67 \fBbool is_syncok(WINDOW *win);\fR
68 .br
69 .SH DESCRIPTION
70 This implementation provides functions which return properties
71 set in the WINDOW structure, allowing it to be ``opaque'' if
72 the symbol \fBNCURSES_OPAQUE\fR is defined:
73 .TP 5
74 \fBis_cleared\fR
75 returns the value set in \fBclearok\fR
76 .TP 5
77 \fBis_idcok\fR
78 returns the value set in \fBidcok\fR
79 .TP 5
80 \fBis_idlok\fR
81 returns the value set in \fBidlok\fR
82 .TP 5
83 \fBis_immedok\fR
84 returns the value set in \fBimmedok\fR
85 .TP 5
86 \fBis_keypad\fR
87 returns the value set in \fBkeypad\fR
88 .TP 5
89 \fBis_leaveok\fR
90 returns the value set in \fBleaveok\fR
91 .TP 5
92 \fBis_nodelay\fR
93 returns the value set in \fBnodelay\fR
94 .TP 5
95 \fBis_notimeout\fR
96 returns the value set in \fBnotimeout\fR
97 .TP 5
98 \fBis_scrollok\fR
99 returns the value set in \fBscrollok\fR
100 .TP 5
101 \fBis_syncok\fR
102 returns the value set in \fBsyncok\fR
103 .SH RETURN VALUE
104 These functions all return TRUE or FALSE.
105 .SH NOTES
106 Both a macro and a function are provided for each name.
107 .SH PORTABILITY
108 These routines are specific to ncurses.
109 They were not supported on Version 7, BSD or System V implementations.
110 It is recommended that any code depending on ncurses extensions
111 be conditioned using NCURSES_VERSION.
112 .SH SEE ALSO
113 \fBcurses\fR(3X),
114 \fBcurs_inopts\fR(3X),
115 \fBcurs_outopts\fR(3X),
116 \fBcurs_window\fR(3X)
117 .\"#
118 .\"# The following sets edit modes for GNU EMACS
119 .\"# Local Variables:
120 .\"# mode:nroff
121 .\"# fill-column:79
122 .\"# End: