X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_opaque.3x;h=1596bfff4405be1efc66a80b18758d32f9eac8fb;hp=f3ad22e1482eac35ab0e45d164206594c9ca0c03;hb=6b99a559185b3b8fad80b56bc2070b08101c33d1;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x index f3ad22e1..1596bfff 100644 --- a/man/curs_opaque.3x +++ b/man/curs_opaque.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2007-2009,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 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 * @@ -26,8 +26,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ +.\" $Id: curs_opaque.3x,v 1.13 2015/12/05 20:05:45 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 @@ -42,7 +46,10 @@ \fBis_pad\fR, \fBis_scrollok\fR, \fBis_subwin\fR, -\fBis_syncok\fR \- \fBcurses\fR window properties +\fBis_syncok\fR, +\fBwgetdelay\fR, +\fBwgetparent\fR, +\fBwgetscrreg\fR \- \fBcurses\fR window properties .ad .hy .SH SYNOPSIS @@ -74,11 +81,13 @@ .br \fBWINDOW * wgetparent(const WINDOW *win);\fR .br +\fBint wgetdelay(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 -set in the WINDOW structure, allowing it to be ``opaque'' if +set in the WINDOW structure, allowing it to be \*(``opaque\*('' if the symbol \fBNCURSES_OPAQUE\fR is defined: .TP 5 \fBis_cleared\fR @@ -106,27 +115,31 @@ returns the value set in \fBnodelay\fR returns the value set in \fBnotimeout\fR .TP 5 \fBis_pad\fR -returns TRUE if the window is a pad +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 .TP 5 \fBis_subwin\fR -returns TRUE if the window is a subwindow, +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 .TP 5 +\fBwgetdelay\fR +returns the delay timeout as set in \fBwtimeout\fP. +.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. +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