man/curs_opaque.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2020-2022,2023 Thomas E. Dickey                                *
   3 .\" Copyright 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 .\"
  30 .\" $Id: curs_opaque.3x,v 1.36 2023/10/07 21:19:07 tom Exp $
  31 .TH curs_opaque 3X 2023-10-07 "ncurses 6.4" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .SH NAME
  43 \fB\%is_cleared\fP,
  44 \fB\%is_idlok\fP,
  45 \fB\%is_idcok\fP,
  46 \fB\%is_immedok\fP,
  47 \fB\%is_keypad\fP,
  48 \fB\%is_leaveok\fP,
  49 \fB\%is_nodelay\fP,
  50 \fB\%is_notimeout\fP,
  51 \fB\%is_pad\fP,
  52 \fB\%is_scrollok\fP,
  53 \fB\%is_subwin\fP,
  54 \fB\%is_syncok\fP,
  55 \fB\%wgetdelay\fP,
  56 \fB\%wgetparent\fP,
  57 \fB\%wgetscrreg\fP \-
  58 obtain \fIcurses\fR window properties
  59 .SH SYNOPSIS
  60 .nf
  61 \fB#include <curses.h>
  62 .PP
  63 \fBbool is_cleared(const WINDOW *\fIwin\fP);
  64 \fBbool is_idcok(const WINDOW *\fIwin\fP);
  65 \fBbool is_idlok(const WINDOW *\fIwin\fP);
  66 \fBbool is_immedok(const WINDOW *\fIwin\fP);
  67 \fBbool is_keypad(const WINDOW *\fIwin\fP);
  68 \fBbool is_leaveok(const WINDOW *\fIwin\fP);
  69 \fBbool is_nodelay(const WINDOW *\fIwin\fP);
  70 \fBbool is_notimeout(const WINDOW *\fIwin\fP);
  71 \fBbool is_pad(const WINDOW *\fIwin\fP);
  72 \fBbool is_scrollok(const WINDOW *\fIwin\fP);
  73 \fBbool is_subwin(const WINDOW *\fIwin\fP);
  74 \fBbool is_syncok(const WINDOW *\fIwin\fP);
  75 .PP
  76 \fBWINDOW * wgetparent(const WINDOW *\fIwin\fP);
  77 \fBint wgetdelay(const WINDOW *\fIwin\fP);
  78 \fBint wgetscrreg(const WINDOW *\fIwin\fP, int *\fItop\fP, int *\fIbottom\fP);
  79 .fi
  80 .SH DESCRIPTION
  81 \fIncurses\fP provides functions returning properties of a
  82 \fI\%WINDOW\fP structure,
  83 allowing it to be \*(``opaque\*('' if
  84 the application defines the \fB\%NCURSES_OPAQUE\fP preprocessor symbol.
  85 .TP
  86 \fBis_cleared\fP
  87 returns the value set by \fB\%clearok\fP(3X).
  88 .TP
  89 \fBis_idcok\fP
  90 returns the value set by \fB\%idcok\fP(3X).
  91 .TP
  92 \fBis_idlok\fP
  93 returns the value set by \fB\%idlok\fP(3X).
  94 .TP
  95 \fBis_immedok\fP
  96 returns the value set by \fB\%immedok\fP(3X).
  97 .TP
  98 \fBis_keypad\fP
  99 returns the value set by \fB\%keypad\fP(3X).
 100 .TP
 101 \fBis_leaveok\fP
 102 returns the value set by \fB\%leaveok\fP(3X).
 103 .TP
 104 \fBis_nodelay\fP
 105 returns the value set by \fB\%nodelay\fP(3X).
 106 .TP
 107 \fBis_notimeout\fP
 108 returns the value set by \fB\%notimeout\fP(3X).
 109 .TP
 110 \fBis_pad\fP
 111 returns \fBTRUE\fP if the window is a pad;
 112 that is,
 113 it created by \fB\%newpad\fP(3X).
 114 .TP
 115 \fBis_scrollok\fP
 116 returns the value set by \fB\%scrollok\fP(3X).
 117 .TP
 118 \fBis_subwin\fP
 119 returns \fBTRUE\fP if the window is a subwindow,
 120 that is,
 121 it was created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X).
 122 .TP
 123 \fBis_syncok\fP
 124 returns the value set by \fB\%syncok\fP(3X).
 125 .TP
 126 \fBwgetdelay\fP
 127 returns the delay timeout set by \fB\%wtimeout\fP(3X).
 128 .TP
 129 \fBwgetparent\fP
 130 returns the parent \fI\%WINDOW\fP pointer for subwindows,
 131 or \fBNULL\fP for windows having no parent.
 132 .TP
 133 \fBwgetscrreg\fP
 134 stores the the top and bottom rows for the scrolling margin set by
 135 \fB\%wsetscrreg\fP(3X) in the corresponding arguments,
 136 returning \fBERR\fP upon failure and \fBOK\fP upon successful
 137 completion.
 138 .SH RETURN VALUE
 139 These functions return \fBTRUE\fP or \fBFALSE\fP except as noted.
 140 .SH NOTES
 141 \fIncurses\fP provides both a C function and a preprocessor macro for
 142 each function documented in this page.
 143 .SH PORTABILITY
 144 These routines are specific to \fIncurses\fP.
 145 They were not supported on Version 7, BSD or System V implementations.
 146 It is recommended that any code depending on \fIncurses\fP extensions
 147 be conditioned using \fB\%NCURSES_VERSION\fP.
 148 .SH SEE ALSO
 149 \fB\%curses\fP(3X),
 150 \fB\%curs_inopts\fP(3X),
 151 \fB\%curs_outopts\fP(3X),
 152 \fB\%curs_threads\fP(3X),
 153 \fB\%curs_window\fP(3X)