Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / man / curs_opaque.3x
blob: b395950dae36f5a978bde27a7fe66c362a00754d [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]2.\" Copyright (c) 2007-2014,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]3.\" *
4.\" Permission is hereby granted, free of charge, to any person obtaining a *
5.\" copy of this software and associated documentation files (the *
6.\" "Software"), to deal in the Software without restriction, including *
7.\" without limitation the rights to use, copy, modify, merge, publish, *
8.\" distribute, distribute with modifications, sublicense, and/or sell *
9.\" copies of the Software, and to permit persons to whom the Software is *
10.\" furnished to do so, subject to the following conditions: *
11.\" *
12.\" The above copyright notice and this permission notice shall be included *
13.\" in all copies or substantial portions of the Software. *
14.\" *
15.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
22.\" *
23.\" Except as contained in this notice, the name(s) of the above copyright *
24.\" holders shall not be used in advertising or otherwise to promote the *
25.\" sale, use or other dealings in this Software without prior written *
26.\" authorization. *
27.\"***************************************************************************
28.\"
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]29.\" $Id: curs_opaque.3x,v 1.12 2015/04/11 10:23:49 tom Exp $
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30.TH curs_opaque 3X ""
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]31.ie \n(.g .ds `` \(lq
32.el .ds `` ``
33.ie \n(.g .ds '' \(rq
34.el .ds '' ''
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]35.na
36.hy 0
37.SH NAME
38\fBis_cleared\fR,
39\fBis_idlok\fR,
40\fBis_idcok\fR,
41\fBis_immedok\fR,
42\fBis_keypad\fR,
43\fBis_leaveok\fR,
44\fBis_nodelay\fR,
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]45\fBis_notimeout\fR,
46\fBis_pad\fR,
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]47\fBis_scrollok\fR,
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]48\fBis_subwin\fR,
49\fBis_syncok\fR \- \fBcurses\fR window properties
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50.ad
51.hy
52.SH SYNOPSIS
53\fB#include <curses.h>\fR
54.sp
55\fBbool is_cleared(const WINDOW *win);\fR
56.br
57\fBbool is_idcok(const WINDOW *win);\fR
58.br
59\fBbool is_idlok(const WINDOW *win);\fR
60.br
61\fBbool is_immedok(const WINDOW *win);\fR
62.br
63\fBbool is_keypad(const WINDOW *win);\fR
64.br
65\fBbool is_leaveok(const WINDOW *win);\fR
66.br
67\fBbool is_nodelay(const WINDOW *win);\fR
68.br
69\fBbool is_notimeout(const WINDOW *win);\fR
70.br
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]71\fBbool is_pad(const WINDOW *win);\fR
72.br
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]73\fBbool is_scrollok(const WINDOW *win);\fR
74.br
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]75\fBbool is_subwin(const WINDOW *win);\fR
76.br
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]77\fBbool is_syncok(const WINDOW *win);\fR
78.br
79\fBWINDOW * wgetparent(const WINDOW *win);\fR
80.br
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]81\fBint wgetdelay(const WINDOW *win);\fR
82.br
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]83\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR
84.br
85.SH DESCRIPTION
86This implementation provides functions which return properties
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]87set in the WINDOW structure, allowing it to be \*(``opaque\*('' if
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]88the symbol \fBNCURSES_OPAQUE\fR is defined:
89.TP 5
90\fBis_cleared\fR
91returns the value set in \fBclearok\fR
92.TP 5
93\fBis_idcok\fR
94returns the value set in \fBidcok\fR
95.TP 5
96\fBis_idlok\fR
97returns the value set in \fBidlok\fR
98.TP 5
99\fBis_immedok\fR
100returns the value set in \fBimmedok\fR
101.TP 5
102\fBis_keypad\fR
103returns the value set in \fBkeypad\fR
104.TP 5
105\fBis_leaveok\fR
106returns the value set in \fBleaveok\fR
107.TP 5
108\fBis_nodelay\fR
109returns the value set in \fBnodelay\fR
110.TP 5
111\fBis_notimeout\fR
112returns the value set in \fBnotimeout\fR
113.TP 5
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]114\fBis_pad\fR
115returns \fBTRUE\fP if the window is a pad
116i.e., created by \fBnewpad\fP
117.TP 5
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]118\fBis_scrollok\fR
119returns the value set in \fBscrollok\fR
120.TP 5
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]121\fBis_subwin\fR
122returns \fBTRUE\fP if the window is a subwindow,
123i.e., created by \fBsubwin\fP or \fBderwin\fP
124.TP 5
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]125\fBis_syncok\fR
126returns the value set in \fBsyncok\fR
127.TP 5
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]128\fBwgetdelay\fR
129returns the delay timeout as set in \fBwtimeout\fP.
130.TP 5
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]131\fBwgetparent\fR
132returns the parent WINDOW pointer for subwindows,
133or NULL for windows having no parent.
134.TP 5
135\fBwgetscrreg\fR
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]136returns the top and bottom rows for the scrolling margin
137as set in \fBwsetscrreg\fP.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]138.SH RETURN VALUE
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]139These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]140.SH NOTES
141Both a macro and a function are provided for each name.
142.SH PORTABILITY
143These routines are specific to ncurses.
144They were not supported on Version 7, BSD or System V implementations.
145It is recommended that any code depending on ncurses extensions
146be conditioned using NCURSES_VERSION.
147.SH SEE ALSO
148\fBcurses\fR(3X),
149\fBcurs_inopts\fR(3X),
150\fBcurs_outopts\fR(3X),
151\fBcurs_window\fR(3X)