]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_opaque.3x
ncurses 5.6 - patch 20081012
[ncurses.git] / man / curs_opaque.3x
index 1f04fbf2be6c67aa44ed31413a1f9573692f9b2d..6c9cfaa18a35164dfcd3250c7b1a7cc03310a48b 100644 (file)
@@ -26,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_opaque.3x,v 1.1 2007/04/07 23:19:40 tom Exp $
+.\" $Id: curs_opaque.3x,v 1.6 2007/09/08 18:49:13 tom Exp $
 .TH curs_opaque 3X ""
 .na
 .hy 0
 \fBis_nodelay\fR,
 \fBis_timeout\fR,
 \fBis_scrollok\fR,
-\fBis_syncok\fR - \fBcurses\fR output options
+\fBis_syncok\fR - \fBcurses\fR window properties
 .ad
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp
-\fBbool is_cleared (WINDOW *win);\fR
+\fBbool is_cleared(const WINDOW *win);\fR
 .br
-\fBbool is_idcok (WINDOW *win);\fR
+\fBbool is_idcok(const WINDOW *win);\fR
 .br
-\fBbool is_idlok (WINDOW *win);\fR
+\fBbool is_idlok(const WINDOW *win);\fR
 .br
-\fBbool is_immedok (WINDOW *win);\fR
+\fBbool is_immedok(const WINDOW *win);\fR
 .br
-\fBbool is_keypad (WINDOW *win);\fR
+\fBbool is_keypad(const WINDOW *win);\fR
 .br
-\fBbool is_leaveok (WINDOW *win);\fR
+\fBbool is_leaveok(const WINDOW *win);\fR
 .br
-\fBbool is_nodelay (WINDOW *win);\fR
+\fBbool is_nodelay(const WINDOW *win);\fR
 .br
-\fBbool is_notimeout (WINDOW *win);\fR
+\fBbool is_notimeout(const WINDOW *win);\fR
 .br
-\fBbool is_scrollok (WINDOW *win);\fR
+\fBbool is_scrollok(const WINDOW *win);\fR
 .br
-\fBbool is_syncok (WINDOW *win);\fR
+\fBbool is_syncok(const WINDOW *win);\fR
+.br
+\fBWINDOW * wgetparent(const WINDOW *win);\fR
+.br
+\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR
 .br
 .SH DESCRIPTION
 This implementation provides functions which return properties
@@ -100,9 +104,15 @@ returns the value set in \fBscrollok\fR
 .TP 5
 \fBis_syncok\fR
 returns the value set in \fBsyncok\fR
-.RE
+.TP 5
+\fBwgetparent\fR
+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.
 .SH RETURN VALUE
-These functions all return TRUE or FALSE.
+These functions all return TRUE or FALSE, except as noted.
 .SH NOTES
 Both a macro and a function are provided for each name.
 .SH PORTABILITY