1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> 2<!-- 3 **************************************************************************** 4 * Copyright (c) 2007 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.6 2007/09/08 18:49:13 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_timeout</STRONG>, <STRONG>is_scrollok</STRONG>, <STRONG>is_syncok</STRONG> 52 - <STRONG>curses</STRONG> window properties 53 54 55</PRE> 56<H2>SYNOPSIS</H2><PRE> 57 <STRONG>#include</STRONG> <STRONG><curses.h></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_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> 68 <STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> 69 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG> 70 <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> 71 72 73</PRE> 74<H2>DESCRIPTION</H2><PRE> 75 This implementation provides functions which return prop- 76 erties set in the WINDOW structure, allowing it to be 77 ``opaque'' if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined: 78 79 <STRONG>is_cleared</STRONG> 80 returns the value set in <STRONG>clearok</STRONG> 81 82 <STRONG>is_idcok</STRONG> 83 returns the value set in <STRONG>idcok</STRONG> 84 85 <STRONG>is_idlok</STRONG> 86 returns the value set in <STRONG>idlok</STRONG> 87 88 <STRONG>is_immedok</STRONG> 89 returns the value set in <STRONG>immedok</STRONG> 90 91 <STRONG>is_keypad</STRONG> 92 returns the value set in <STRONG>keypad</STRONG> 93 94 <STRONG>is_leaveok</STRONG> 95 returns the value set in <STRONG>leaveok</STRONG> 96 97 <STRONG>is_nodelay</STRONG> 98 returns the value set in <STRONG>nodelay</STRONG> 99 100 <STRONG>is_notimeout</STRONG> 101 returns the value set in <STRONG>notimeout</STRONG> 102 103 <STRONG>is_scrollok</STRONG> 104 returns the value set in <STRONG>scrollok</STRONG> 105 106 <STRONG>is_syncok</STRONG> 107 returns the value set in <STRONG>syncok</STRONG> 108 109 <STRONG>wgetparent</STRONG> 110 returns the parent WINDOW pointer for subwindows, or 111 NULL for windows having no parent. 112 113 <STRONG>wgetscrreg</STRONG> 114 returns the top and bottom rows for the scrolling 115 margin as set in <STRONG>wsetscrreg</STRONG>. 116 117 118</PRE> 119<H2>RETURN VALUE</H2><PRE> 120 These functions all return TRUE or FALSE, except as noted. 121 122 123</PRE> 124<H2>NOTES</H2><PRE> 125 Both a macro and a function are provided for each name. 126 127 128</PRE> 129<H2>PORTABILITY</H2><PRE> 130 These routines are specific to ncurses. They were not 131 supported on Version 7, BSD or System V implementations. 132 It is recommended that any code depending on ncurses ex- 133 tensions be conditioned using NCURSES_VERSION. 134 135 136</PRE> 137<H2>SEE ALSO</H2><PRE> 138 <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> 139 <STRONG><A HREF="curs_window.3x.html">dow(3x)</A></STRONG> 140 141 142 143 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> 144</PRE> 145<HR> 146<ADDRESS> 147Man(1) output converted with 148<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> 149</ADDRESS> 150</BODY> 151</HTML> 152