ncurses 5.9 - patch 20130518
[ncurses.git] / doc / html / man / curs_opaque.3x.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2007-2009,2010 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_opaque.3x,v 1.9 2010/12/04 18:40:45 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_opaque 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_opaque 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>                                         <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>is_cleared</STRONG>, <STRONG>is_idlok</STRONG>, <STRONG>is_idcok</STRONG>, <STRONG>is_immedok</STRONG>, <STRONG>is_keypad</STRONG>,
51        <STRONG>is_leaveok</STRONG>, <STRONG>is_nodelay</STRONG>, <STRONG>is_notimeout</STRONG>, <STRONG>is_pad</STRONG>, <STRONG>is_scrollok</STRONG>,
52        <STRONG>is_subwin</STRONG>, <STRONG>is_syncok</STRONG> - <STRONG>curses</STRONG> window properties
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59        <STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
60        <STRONG>bool</STRONG> <STRONG>is_idcok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
61        <STRONG>bool</STRONG> <STRONG>is_idlok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
62        <STRONG>bool</STRONG> <STRONG>is_immedok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
63        <STRONG>bool</STRONG> <STRONG>is_keypad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
64        <STRONG>bool</STRONG> <STRONG>is_leaveok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
65        <STRONG>bool</STRONG> <STRONG>is_nodelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
66        <STRONG>bool</STRONG> <STRONG>is_notimeout(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
67        <STRONG>bool</STRONG> <STRONG>is_pad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
68        <STRONG>bool</STRONG> <STRONG>is_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
69        <STRONG>bool</STRONG> <STRONG>is_subwin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
70        <STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
71        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
72        <STRONG>int</STRONG> <STRONG>wgetscrreg(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>*top,</STRONG> <STRONG>int</STRONG> <STRONG>*bottom);</STRONG>
73
74
75 </PRE>
76 <H2>DESCRIPTION</H2><PRE>
77        This  implementation provides functions which return prop-
78        erties set in the WINDOW  structure,  allowing  it  to  be
79        ``opaque'' if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined:
80
81        <STRONG>is_cleared</STRONG>
82             returns the value set in <STRONG>clearok</STRONG>
83
84        <STRONG>is_idcok</STRONG>
85             returns the value set in <STRONG>idcok</STRONG>
86
87        <STRONG>is_idlok</STRONG>
88             returns the value set in <STRONG>idlok</STRONG>
89
90        <STRONG>is_immedok</STRONG>
91             returns the value set in <STRONG>immedok</STRONG>
92
93        <STRONG>is_keypad</STRONG>
94             returns the value set in <STRONG>keypad</STRONG>
95
96        <STRONG>is_leaveok</STRONG>
97             returns the value set in <STRONG>leaveok</STRONG>
98
99        <STRONG>is_nodelay</STRONG>
100             returns the value set in <STRONG>nodelay</STRONG>
101
102        <STRONG>is_notimeout</STRONG>
103             returns the value set in <STRONG>notimeout</STRONG>
104
105        <STRONG>is_pad</STRONG>
106             returns  TRUE if the window is a pad i.e., created by
107             <STRONG>newpad</STRONG>
108
109        <STRONG>is_scrollok</STRONG>
110             returns the value set in <STRONG>scrollok</STRONG>
111
112        <STRONG>is_subwin</STRONG>
113             returns TRUE if the window is a subwindow, i.e., cre-
114             ated by <STRONG>subwin</STRONG> or <STRONG>derwin</STRONG>
115
116        <STRONG>is_syncok</STRONG>
117             returns the value set in <STRONG>syncok</STRONG>
118
119        <STRONG>wgetparent</STRONG>
120             returns  the parent WINDOW pointer for subwindows, or
121             NULL for windows having no parent.
122
123        <STRONG>wgetscrreg</STRONG>
124             returns the top and bottom  rows  for  the  scrolling
125             margin as set in <STRONG>wsetscrreg</STRONG>.
126
127
128 </PRE>
129 <H2>RETURN VALUE</H2><PRE>
130        These functions all return TRUE or FALSE, except as noted.
131
132
133 </PRE>
134 <H2>NOTES</H2><PRE>
135        Both a macro and a function are provided for each name.
136
137
138 </PRE>
139 <H2>PORTABILITY</H2><PRE>
140        These  routines  are  specific  to ncurses.  They were not
141        supported on Version 7, BSD or System  V  implementations.
142        It  is  recommended that any code depending on ncurses ex-
143        tensions be conditioned using NCURSES_VERSION.
144
145
146 </PRE>
147 <H2>SEE ALSO</H2><PRE>
148        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>,  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>,  <STRONG>curs_win-</STRONG>
149        <STRONG><A HREF="curs_window.3x.html">dow(3x)</A></STRONG>
150
151
152
153                                                         <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
154 </PRE>
155 <HR>
156 <ADDRESS>
157 Man(1) output converted with
158 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
159 </ADDRESS>
160 </BODY>
161 </HTML>