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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2020 Thomas E. Dickey                                          *
   4   * Copyright 2007-2014,2015 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.15 2020/10/24 09:41:22 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_opaque 3X</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_opaque 3X</H1>
  43 <PRE>
  44 <B><A HREF="curs_opaque.3X.html">curs_opaque(3X)</A></B>                                                <B><A HREF="curs_opaque.3X.html">curs_opaque(3X)</A></B>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <B>is_cleared</B>, <B>is_idlok</B>, <B>is_idcok</B>, <B>is_immedok</B>, <B>is_keypad</B>, <B>is_leaveok</B>,
  51        <B>is_nodelay</B>, <B>is_notimeout</B>, <B>is_pad</B>, <B>is_scrollok</B>, <B>is_subwin</B>, <B>is_syncok</B>,
  52        <B>wgetdelay</B>, <B>wgetparent</B>, <B>wgetscrreg</B> - <B>curses</B> window properties
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <B>#include</B> <B>&lt;curses.h&gt;</B>
  57
  58        <B>bool</B> <B>is_cleared(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  59        <B>bool</B> <B>is_idcok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  60        <B>bool</B> <B>is_idlok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  61        <B>bool</B> <B>is_immedok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  62        <B>bool</B> <B>is_keypad(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  63        <B>bool</B> <B>is_leaveok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  64        <B>bool</B> <B>is_nodelay(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  65        <B>bool</B> <B>is_notimeout(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  66        <B>bool</B> <B>is_pad(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  67        <B>bool</B> <B>is_scrollok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  68        <B>bool</B> <B>is_subwin(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  69        <B>bool</B> <B>is_syncok(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  70        <B>WINDOW</B> <B>*</B> <B>wgetparent(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  71        <B>int</B> <B>wgetdelay(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
  72        <B>int</B> <B>wgetscrreg(const</B> <B>WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <B>*</B><I>top</I><B>,</B> <B>int</B> <B>*</B><I>bottom</I><B>);</B>
  73
  74
  75 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  76        This  implementation  provides functions which return properties set in
  77        the WINDOW structure, allowing it to be "opaque" if the  symbol  <B>NCURS-</B>
  78        <B>ES_OPAQUE</B> is defined:
  79
  80        <B>is_cleared</B>
  81             returns the value set in <B>clearok</B>
  82
  83        <B>is_idcok</B>
  84             returns the value set in <B>idcok</B>
  85
  86        <B>is_idlok</B>
  87             returns the value set in <B>idlok</B>
  88
  89        <B>is_immedok</B>
  90             returns the value set in <B>immedok</B>
  91
  92        <B>is_keypad</B>
  93             returns the value set in <B>keypad</B>
  94
  95        <B>is_leaveok</B>
  96             returns the value set in <B>leaveok</B>
  97
  98        <B>is_nodelay</B>
  99             returns the value set in <B>nodelay</B>
 100
 101        <B>is_notimeout</B>
 102             returns the value set in <B>notimeout</B>
 103
 104        <B>is_pad</B>
 105             returns <B>TRUE</B> if the window is a pad i.e., created by <B>newpad</B>
 106
 107        <B>is_scrollok</B>
 108             returns the value set in <B>scrollok</B>
 109
 110        <B>is_subwin</B>
 111             returns <B>TRUE</B> if the window is a subwindow, i.e., created by <B>subwin</B>
 112             or <B>derwin</B>
 113
 114        <B>is_syncok</B>
 115             returns the value set in <B>syncok</B>
 116
 117        <B>wgetdelay</B>
 118             returns the delay timeout as set in <B>wtimeout</B>.
 119
 120        <B>wgetparent</B>
 121             returns the parent WINDOW pointer for subwindows, or NULL for win-
 122             dows having no parent.
 123
 124        <B>wgetscrreg</B>
 125             returns the top and bottom rows for the scrolling margin as set in
 126             <B>wsetscrreg</B>.
 127
 128
 129 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 130        These functions all return <B>TRUE</B> or <B>FALSE</B>, except as noted.
 131
 132
 133 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 134        Both a macro and a function are provided for each name.
 135
 136
 137 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 138        These routines are specific to ncurses.  They  were  not  supported  on
 139        Version 7, BSD or System V implementations.  It is recommended that any
 140        code depending on ncurses extensions be conditioned using  NCURSES_VER-
 141        SION.
 142
 143
 144 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 145        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_inopts.3X.html">curs_inopts(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>, <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>
 146
 147
 148
 149                                                                <B><A HREF="curs_opaque.3X.html">curs_opaque(3X)</A></B>
 150 </PRE>
 151 <div class="nav">
 152 <ul>
 153 <li><a href="#h2-NAME">NAME</a></li>
 154 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 155 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 156 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 157 <li><a href="#h2-NOTES">NOTES</a></li>
 158 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 159 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 160 </ul>
 161 </div>
 162 </BODY>
 163 </HTML>