.\"***************************************************************************
-.\" Copyright (c) 2007,2009 Free Software Foundation, Inc. *
+.\" Copyright 2020-2021,2022 Thomas E. Dickey *
+.\" Copyright 2007-2014,2015 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_opaque.3x,v 1.7 2009/09/06 16:01:55 tom Exp $
+.\" $Id: curs_opaque.3x,v 1.18 2022/02/12 20:05:11 tom Exp $
.TH curs_opaque 3X ""
+.ie \n(.g .ds `` \(lq
+.el .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el .ds '' ''
.na
.hy 0
.SH NAME
-\fBis_cleared\fR,
-\fBis_idlok\fR,
-\fBis_idcok\fR,
-\fBis_immedok\fR,
-\fBis_keypad\fR,
-\fBis_leaveok\fR,
-\fBis_nodelay\fR,
-\fBis_notimeout\fR,
-\fBis_pad\fR,
-\fBis_scrollok\fR,
-\fBis_subwin\fR,
-\fBis_syncok\fR - \fBcurses\fR window properties
+\fBis_cleared\fP,
+\fBis_idlok\fP,
+\fBis_idcok\fP,
+\fBis_immedok\fP,
+\fBis_keypad\fP,
+\fBis_leaveok\fP,
+\fBis_nodelay\fP,
+\fBis_notimeout\fP,
+\fBis_pad\fP,
+\fBis_scrollok\fP,
+\fBis_subwin\fP,
+\fBis_syncok\fP,
+\fBwgetdelay\fP,
+\fBwgetparent\fP,
+\fBwgetscrreg\fP \- \fBcurses\fP window properties
.ad
.hy
.SH SYNOPSIS
-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP
.sp
-\fBbool is_cleared(const WINDOW *win);\fR
+\fBbool is_cleared(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_idcok(const WINDOW *win);\fR
+\fBbool is_idcok(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_idlok(const WINDOW *win);\fR
+\fBbool is_idlok(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_immedok(const WINDOW *win);\fR
+\fBbool is_immedok(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_keypad(const WINDOW *win);\fR
+\fBbool is_keypad(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_leaveok(const WINDOW *win);\fR
+\fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_nodelay(const WINDOW *win);\fR
+\fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_notimeout(const WINDOW *win);\fR
+\fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_pad(const WINDOW *win);\fR
+\fBbool is_pad(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_scrollok(const WINDOW *win);\fR
+\fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_subwin(const WINDOW *win);\fR
+\fBbool is_subwin(const WINDOW *\fIwin\fB);\fR
.br
-\fBbool is_syncok(const WINDOW *win);\fR
+\fBbool is_syncok(const WINDOW *\fIwin\fB);\fR
.br
-\fBWINDOW * wgetparent(const WINDOW *win);\fR
+\fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR
.br
-\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR
+\fBint wgetdelay(const WINDOW *\fIwin\fB);\fR
+.br
+\fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR
.br
.SH DESCRIPTION
This implementation provides functions which return properties
-set in the WINDOW structure, allowing it to be ``opaque'' if
-the symbol \fBNCURSES_OPAQUE\fR is defined:
+set in the WINDOW structure, allowing it to be \*(``opaque\*('' if
+the symbol \fBNCURSES_OPAQUE\fP is defined:
.TP 5
-\fBis_cleared\fR
-returns the value set in \fBclearok\fR
+\fBis_cleared\fP
+returns the value set in \fBclearok\fP
.TP 5
-\fBis_idcok\fR
-returns the value set in \fBidcok\fR
+\fBis_idcok\fP
+returns the value set in \fBidcok\fP
.TP 5
-\fBis_idlok\fR
-returns the value set in \fBidlok\fR
+\fBis_idlok\fP
+returns the value set in \fBidlok\fP
.TP 5
-\fBis_immedok\fR
-returns the value set in \fBimmedok\fR
+\fBis_immedok\fP
+returns the value set in \fBimmedok\fP
.TP 5
-\fBis_keypad\fR
-returns the value set in \fBkeypad\fR
+\fBis_keypad\fP
+returns the value set in \fBkeypad\fP
.TP 5
-\fBis_leaveok\fR
-returns the value set in \fBleaveok\fR
+\fBis_leaveok\fP
+returns the value set in \fBleaveok\fP
.TP 5
-\fBis_nodelay\fR
-returns the value set in \fBnodelay\fR
+\fBis_nodelay\fP
+returns the value set in \fBnodelay\fP
.TP 5
-\fBis_notimeout\fR
-returns the value set in \fBnotimeout\fR
+\fBis_notimeout\fP
+returns the value set in \fBnotimeout\fP
.TP 5
-\fBis_pad\fR
-returns TRUE if the window is a pad
+\fBis_pad\fP
+returns \fBTRUE\fP if the window is a pad
i.e., created by \fBnewpad\fP
.TP 5
-\fBis_scrollok\fR
-returns the value set in \fBscrollok\fR
+\fBis_scrollok\fP
+returns the value set in \fBscrollok\fP
.TP 5
-\fBis_subwin\fR
-returns TRUE if the window is a subwindow,
+\fBis_subwin\fP
+returns \fBTRUE\fP if the window is a subwindow,
i.e., created by \fBsubwin\fP or \fBderwin\fP
.TP 5
-\fBis_syncok\fR
-returns the value set in \fBsyncok\fR
+\fBis_syncok\fP
+returns the value set in \fBsyncok\fP
+.TP 5
+\fBwgetdelay\fP
+returns the delay timeout as set in \fBwtimeout\fP.
.TP 5
-\fBwgetparent\fR
+\fBwgetparent\fP
returns the parent WINDOW pointer for subwindows,
or NULL for windows having no parent.
.TP 5
-\fBwgetscrreg\fR
-returns the top and bottom rows for the scrolling margin as set in \fBwsetscrreg\fP.
+\fBwgetscrreg\fP
+returns the top and bottom rows for the scrolling margin
+as set in \fBwsetscrreg\fP.
.SH RETURN VALUE
-These functions all return TRUE or FALSE, except as noted.
+These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted.
.SH NOTES
Both a macro and a function are provided for each name.
.SH PORTABILITY
It is recommended that any code depending on ncurses extensions
be conditioned using NCURSES_VERSION.
.SH SEE ALSO
-\fBcurses\fR(3X),
-\fBcurs_inopts\fR(3X),
-\fBcurs_outopts\fR(3X),
-\fBcurs_window\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurses\fP(3X),
+\fBcurs_inopts\fP(3X),
+\fBcurs_outopts\fP(3X),
+\fBcurs_window\fP(3X)
projects / ncurses.git / blobdiff