ncurses 6.0 - patch 20150725
[ncurses.git] / man / curs_opaque.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2007-2014,2015 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.12 2015/04/11 10:23:49 tom Exp $
30 .TH curs_opaque 3X ""
31 .ie \n(.g .ds `` \(lq
32 .el       .ds `` ``
33 .ie \n(.g .ds '' \(rq
34 .el       .ds '' ''
35 .na
36 .hy 0
37 .SH NAME
38 \fBis_cleared\fR,
39 \fBis_idlok\fR,
40 \fBis_idcok\fR,
41 \fBis_immedok\fR,
42 \fBis_keypad\fR,
43 \fBis_leaveok\fR,
44 \fBis_nodelay\fR,
45 \fBis_notimeout\fR,
46 \fBis_pad\fR,
47 \fBis_scrollok\fR,
48 \fBis_subwin\fR,
49 \fBis_syncok\fR \- \fBcurses\fR window properties
50 .ad
51 .hy
52 .SH SYNOPSIS
53 \fB#include <curses.h>\fR
54 .sp
55 \fBbool is_cleared(const WINDOW *win);\fR
56 .br
57 \fBbool is_idcok(const WINDOW *win);\fR
58 .br
59 \fBbool is_idlok(const WINDOW *win);\fR
60 .br
61 \fBbool is_immedok(const WINDOW *win);\fR
62 .br
63 \fBbool is_keypad(const WINDOW *win);\fR
64 .br
65 \fBbool is_leaveok(const WINDOW *win);\fR
66 .br
67 \fBbool is_nodelay(const WINDOW *win);\fR
68 .br
69 \fBbool is_notimeout(const WINDOW *win);\fR
70 .br
71 \fBbool is_pad(const WINDOW *win);\fR
72 .br
73 \fBbool is_scrollok(const WINDOW *win);\fR
74 .br
75 \fBbool is_subwin(const WINDOW *win);\fR
76 .br
77 \fBbool is_syncok(const WINDOW *win);\fR
78 .br
79 \fBWINDOW * wgetparent(const WINDOW *win);\fR
80 .br
81 \fBint wgetdelay(const WINDOW *win);\fR
82 .br
83 \fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR
84 .br
85 .SH DESCRIPTION
86 This implementation provides functions which return properties
87 set in the WINDOW structure, allowing it to be \*(``opaque\*('' if
88 the symbol \fBNCURSES_OPAQUE\fR is defined:
89 .TP 5
90 \fBis_cleared\fR
91 returns the value set in \fBclearok\fR
92 .TP 5
93 \fBis_idcok\fR
94 returns the value set in \fBidcok\fR
95 .TP 5
96 \fBis_idlok\fR
97 returns the value set in \fBidlok\fR
98 .TP 5
99 \fBis_immedok\fR
100 returns the value set in \fBimmedok\fR
101 .TP 5
102 \fBis_keypad\fR
103 returns the value set in \fBkeypad\fR
104 .TP 5
105 \fBis_leaveok\fR
106 returns the value set in \fBleaveok\fR
107 .TP 5
108 \fBis_nodelay\fR
109 returns the value set in \fBnodelay\fR
110 .TP 5
111 \fBis_notimeout\fR
112 returns the value set in \fBnotimeout\fR
113 .TP 5
114 \fBis_pad\fR
115 returns \fBTRUE\fP if the window is a pad
116 i.e., created by \fBnewpad\fP
117 .TP 5
118 \fBis_scrollok\fR
119 returns the value set in \fBscrollok\fR
120 .TP 5
121 \fBis_subwin\fR
122 returns \fBTRUE\fP if the window is a subwindow,
123 i.e., created by \fBsubwin\fP or \fBderwin\fP
124 .TP 5
125 \fBis_syncok\fR
126 returns the value set in \fBsyncok\fR
127 .TP 5
128 \fBwgetdelay\fR
129 returns the delay timeout as set in \fBwtimeout\fP.
130 .TP 5
131 \fBwgetparent\fR
132 returns the parent WINDOW pointer for subwindows,
133 or NULL for windows having no parent.
134 .TP 5
135 \fBwgetscrreg\fR
136 returns the top and bottom rows for the scrolling margin
137 as set in \fBwsetscrreg\fP.
138 .SH RETURN VALUE
139 These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted.
140 .SH NOTES
141 Both a macro and a function are provided for each name.
142 .SH PORTABILITY
143 These routines are specific to ncurses.
144 They were not supported on Version 7, BSD or System V implementations.
145 It is recommended that any code depending on ncurses extensions
146 be conditioned using NCURSES_VERSION.
147 .SH SEE ALSO
148 \fBcurses\fR(3X),
149 \fBcurs_inopts\fR(3X),
150 \fBcurs_outopts\fR(3X),
151 \fBcurs_window\fR(3X)