1curs_opaque(3X)                                                curs_opaque(3X)
2
3
4

NAME

6       is_cleared, is_idlok, is_idcok, is_immedok, is_keypad, is_leaveok,
7       is_nodelay, is_notimeout, is_pad, is_scrollok, is_subwin, is_syncok,
8       wgetdelay, wgetparent, wgetscrreg - curses window properties
9

SYNOPSIS

11       #include <curses.h>
12
13       bool is_cleared(const WINDOW *win);
14       bool is_idcok(const WINDOW *win);
15       bool is_idlok(const WINDOW *win);
16       bool is_immedok(const WINDOW *win);
17       bool is_keypad(const WINDOW *win);
18       bool is_leaveok(const WINDOW *win);
19       bool is_nodelay(const WINDOW *win);
20       bool is_notimeout(const WINDOW *win);
21       bool is_pad(const WINDOW *win);
22       bool is_scrollok(const WINDOW *win);
23       bool is_subwin(const WINDOW *win);
24       bool is_syncok(const WINDOW *win);
25       WINDOW * wgetparent(const WINDOW *win);
26       int wgetdelay(const WINDOW *win);
27       int wgetscrreg(const WINDOW *win, int *top, int *bottom);
28

DESCRIPTION

30       This  implementation  provides functions which return properties set in
31       the WINDOW structure, allowing it to be “opaque” if the  symbol  NCURS‐
32       ES_OPAQUE is defined:
33
34       is_cleared
35            returns the value set in clearok(3X)
36
37       is_idcok
38            returns the value set in idcok(3X)
39
40       is_idlok
41            returns the value set in idlok(3X)
42
43       is_immedok
44            returns the value set in immedok(3X)
45
46       is_keypad
47            returns the value set in keypad(3X)
48
49       is_leaveok
50            returns the value set in leaveok(3X)
51
52       is_nodelay
53            returns the value set in nodelay(3X)
54
55       is_notimeout
56            returns the value set in notimeout(3X)
57
58       is_pad
59            returns TRUE if the window is a pad i.e., created by newpad(3X)
60
61       is_scrollok
62            returns the value set in scrollok(3X)
63
64       is_subwin
65            returns  TRUE  if the window is a subwindow, i.e., created by sub‐
66            win(3X) or derwin(3X)
67
68       is_syncok
69            returns the value set in syncok(3X)
70
71       wgetdelay
72            returns the delay timeout as set in wtimeout(3X).
73
74       wgetparent
75            returns the parent WINDOW pointer for subwindows, or NULL for win‐
76            dows having no parent.
77
78       wgetscrreg
79            returns the top and bottom rows for the scrolling margin as set in
80            wsetscrreg.
81

RETURN VALUE

83       These functions all return TRUE or FALSE, except as noted.
84

NOTES

86       Both a macro and a function are provided for each name.
87

PORTABILITY

89       These routines are specific to ncurses.  They  were  not  supported  on
90       Version 7, BSD or System V implementations.  It is recommended that any
91       code depending on ncurses extensions be conditioned using  NCURSES_VER‐
92       SION.
93

SEE ALSO

95       curses(3X), curs_inopts(3X), curs_outopts(3X), curs_window(3X)
96
97
98
99                                                               curs_opaque(3X)
Impressum