ncurses 6.1 - patch 20190406
[ncurses.git] / man / curs_opaque.3x
index 7a9e049c515b7e7539ab19794696b62e6751f255..1596bfff4405be1efc66a80b18758d32f9eac8fb 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2007,2009 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_opaque.3x,v 1.7 2009/09/06 16:01:55 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
 \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
 .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
@@ -139,9 +152,3 @@ be conditioned using NCURSES_VERSION.
 \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: