ncurses 5.9 - patch 20141221

[ncurses.git] / man / curs_opaque.3x

diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index d31d734e165a5692fc8a23fe10621d992e2f5cf2..62eb4e0b58a31790ec11099ea96ce79a97d1bcf4 100644 (file)
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2007 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2007-2013,2014 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            *
 .\"                                                                          *
 .\" 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.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_opaque.3x,v 1.5 2007/08/18 18:14:52 tom Exp $
+.\" $Id: curs_opaque.3x,v 1.11 2014/03/15 19:24:23 tom Exp $

 .TH curs_opaque 3X ""
 .TH curs_opaque 3X ""

+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''

 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME


@@ -38,9 +42,11 @@
 \fBis_keypad\fR,
 \fBis_leaveok\fR,
 \fBis_nodelay\fR,
 \fBis_keypad\fR,
 \fBis_leaveok\fR,
 \fBis_nodelay\fR,

-\fBis_timeout\fR,
+\fBis_notimeout\fR,
+\fBis_pad\fR,

 \fBis_scrollok\fR,
 \fBis_scrollok\fR,

-\fBis_syncok\fR - \fBcurses\fR window properties
+\fBis_subwin\fR,
+\fBis_syncok\fR \- \fBcurses\fR window properties

 .ad
 .hy
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS


@@ -62,17 +68,23 @@
 .br
 \fBbool is_notimeout(const WINDOW *win);\fR
 .br
 .br
 \fBbool is_notimeout(const WINDOW *win);\fR
 .br

+\fBbool is_pad(const WINDOW *win);\fR
+.br

 \fBbool is_scrollok(const WINDOW *win);\fR
 .br
 \fBbool is_scrollok(const WINDOW *win);\fR
 .br

+\fBbool is_subwin(const WINDOW *win);\fR
+.br

 \fBbool is_syncok(const WINDOW *win);\fR
 .br
 \fBbool is_syncok(const WINDOW *win);\fR
 .br

-\fBWINDOW * wgetparent (const WINDOW *win);\fR
+\fBWINDOW * wgetparent(const WINDOW *win);\fR
+.br
+\fBint wgetdelay(const WINDOW *win);\fR

 .br
 .br

-\fBint wgetscrreg (const WINDOW *win, int *top, int *bottom);\fR
+\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR

 .br
 .SH DESCRIPTION
 This implementation provides functions which return properties
 .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
 the symbol \fBNCURSES_OPAQUE\fR is defined:
 .TP 5
 \fBis_cleared\fR


@@ -99,18 +111,30 @@ returns the value set in \fBnodelay\fR
 \fBis_notimeout\fR
 returns the value set in \fBnotimeout\fR
 .TP 5
 \fBis_notimeout\fR
 returns the value set in \fBnotimeout\fR
 .TP 5

+\fBis_pad\fR
+returns TRUE 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_scrollok\fR
 returns the value set in \fBscrollok\fR
 .TP 5

+\fBis_subwin\fR
+returns TRUE 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
 \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
 \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.
 .SH NOTES
 .SH RETURN VALUE
 These functions all return TRUE or FALSE, except as noted.
 .SH NOTES


@@ -125,9 +149,3 @@ be conditioned using NCURSES_VERSION.
 \fBcurs_inopts\fR(3X),
 \fBcurs_outopts\fR(3X),
 \fBcurs_window\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: