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