doc/html/man/curs_opaque.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2007-2014,2015 Free Software Foundation, Inc.              *
   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   ****************************************************************************
  29   * @Id: curs_opaque.3x,v 1.13 2015/12/05 20:05:45 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  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">
  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>
  41 <H1 class="no-header">curs_opaque 3x</H1>
  42 <PRE>
  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><a name="h2-NAME">NAME</a></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>wgetdelay</STRONG>, <STRONG>wgetparent</STRONG>, <STRONG>wgetscrreg</STRONG> -
  53        <STRONG>curses</STRONG> window properties
  54
  55
  56 </PRE>
  57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  59
  60        <STRONG>bool</STRONG> <STRONG>is_cleared(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  61        <STRONG>bool</STRONG> <STRONG>is_idcok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  62        <STRONG>bool</STRONG> <STRONG>is_idlok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  63        <STRONG>bool</STRONG> <STRONG>is_immedok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  64        <STRONG>bool</STRONG> <STRONG>is_keypad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  65        <STRONG>bool</STRONG> <STRONG>is_leaveok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  66        <STRONG>bool</STRONG> <STRONG>is_nodelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  67        <STRONG>bool</STRONG> <STRONG>is_notimeout(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  68        <STRONG>bool</STRONG> <STRONG>is_pad(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  69        <STRONG>bool</STRONG> <STRONG>is_scrollok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  70        <STRONG>bool</STRONG> <STRONG>is_subwin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  71        <STRONG>bool</STRONG> <STRONG>is_syncok(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  72        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>wgetparent(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  73        <STRONG>int</STRONG> <STRONG>wgetdelay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
  74        <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>
  75
  76
  77 </PRE>
  78 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  79        This implementation provides functions which return  prop-
  80        erties  set  in  the  WINDOW  structure, allowing it to be
  81        "opaque" if the symbol <STRONG>NCURSES_OPAQUE</STRONG> is defined:
  82
  83        <STRONG>is_cleared</STRONG>
  84             returns the value set in <STRONG>clearok</STRONG>
  85
  86        <STRONG>is_idcok</STRONG>
  87             returns the value set in <STRONG>idcok</STRONG>
  88
  89        <STRONG>is_idlok</STRONG>
  90             returns the value set in <STRONG>idlok</STRONG>
  91
  92        <STRONG>is_immedok</STRONG>
  93             returns the value set in <STRONG>immedok</STRONG>
  94
  95        <STRONG>is_keypad</STRONG>
  96             returns the value set in <STRONG>keypad</STRONG>
  97
  98        <STRONG>is_leaveok</STRONG>
  99             returns the value set in <STRONG>leaveok</STRONG>
 100
 101        <STRONG>is_nodelay</STRONG>
 102             returns the value set in <STRONG>nodelay</STRONG>
 103
 104        <STRONG>is_notimeout</STRONG>
 105             returns the value set in <STRONG>notimeout</STRONG>
 106
 107        <STRONG>is_pad</STRONG>
 108             returns <STRONG>TRUE</STRONG> if the window is a pad i.e., created  by
 109             <STRONG>newpad</STRONG>
 110
 111        <STRONG>is_scrollok</STRONG>
 112             returns the value set in <STRONG>scrollok</STRONG>
 113
 114        <STRONG>is_subwin</STRONG>
 115             returns <STRONG>TRUE</STRONG> if the window is a subwindow, i.e., cre-
 116             ated by <STRONG>subwin</STRONG> or <STRONG>derwin</STRONG>
 117
 118        <STRONG>is_syncok</STRONG>
 119             returns the value set in <STRONG>syncok</STRONG>
 120
 121        <STRONG>wgetdelay</STRONG>
 122             returns the delay timeout as set in <STRONG>wtimeout</STRONG>.
 123
 124        <STRONG>wgetparent</STRONG>
 125             returns the parent WINDOW pointer for subwindows,  or
 126             NULL for windows having no parent.
 127
 128        <STRONG>wgetscrreg</STRONG>
 129             returns  the  top  and  bottom rows for the scrolling
 130             margin as set in <STRONG>wsetscrreg</STRONG>.
 131
 132
 133 </PRE>
 134 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 135        These functions all return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>, except as noted.
 136
 137
 138 </PRE>
 139 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 140        Both a macro and a function are provided for each name.
 141
 142
 143 </PRE>
 144 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 145        These routines are specific to  ncurses.   They  were  not
 146        supported  on  Version 7, BSD or System V implementations.
 147        It is recommended that any code depending on  ncurses  ex-
 148        tensions be conditioned using NCURSES_VERSION.
 149
 150
 151 </PRE>
 152 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 153        <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>
 154        <STRONG><A HREF="curs_window.3x.html">dow(3x)</A></STRONG>
 155
 156
 157
 158                                                         <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
 159 </PRE>
 160 <div class="nav">
 161 <ul>
 162 <li><a href="#h2-NAME">NAME</a></li>
 163 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 164 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 165 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 166 <li><a href="#h2-NOTES">NOTES</a></li>
 167 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 168 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 169 </ul>
 170 </div>
 171 </BODY>
 172 </HTML>