ncurses 6.2 - patch 20210213

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

diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index 8c315ddda432a7879898e88710c93b548147df67..1d0cb55f2bb2e2b9f2469ce95fe493866c2f9870 100644 (file)
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2007-2010,2013 Free Software Foundation, Inc.              *
+.\" Copyright 2020 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_opaque.3x,v 1.10 2013/07/20 19:42:29 tom Exp $
+.\" $Id: curs_opaque.3x,v 1.15 2020/10/24 09:41:22 tom Exp $

 .TH curs_opaque 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .TH curs_opaque 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``


@@ -46,39 +47,44 @@
 \fBis_pad\fR,
 \fBis_scrollok\fR,
 \fBis_subwin\fR,
 \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
 \fB#include <curses.h>\fR
 .sp
 .ad
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp

-\fBbool is_cleared(const WINDOW *win);\fR
+\fBbool is_cleared(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_idcok(const WINDOW *win);\fR
+\fBbool is_idcok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_idlok(const WINDOW *win);\fR
+\fBbool is_idlok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_immedok(const WINDOW *win);\fR
+\fBbool is_immedok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_keypad(const WINDOW *win);\fR
+\fBbool is_keypad(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_leaveok(const WINDOW *win);\fR
+\fBbool is_leaveok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_nodelay(const WINDOW *win);\fR
+\fBbool is_nodelay(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_notimeout(const WINDOW *win);\fR
+\fBbool is_notimeout(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_pad(const WINDOW *win);\fR
+\fBbool is_pad(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_scrollok(const WINDOW *win);\fR
+\fBbool is_scrollok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_subwin(const WINDOW *win);\fR
+\fBbool is_subwin(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBbool is_syncok(const WINDOW *win);\fR
+\fBbool is_syncok(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBWINDOW * wgetparent(const WINDOW *win);\fR
+\fBWINDOW * wgetparent(const WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .br

-\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR
+\fBint wgetdelay(const WINDOW *\fP\fIwin\fP\fB);\fR
+.br
+\fBint wgetscrreg(const WINDOW *\fP\fIwin\fP\fB, int *\fP\fItop\fP\fB, int *\fP\fIbottom\fP\fB);\fR

 .br
 .SH DESCRIPTION
 This implementation provides functions which return properties
 .br
 .SH DESCRIPTION
 This implementation provides functions which return properties


@@ -110,19 +116,22 @@ returns the value set in \fBnodelay\fR
 returns the value set in \fBnotimeout\fR
 .TP 5
 \fBis_pad\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
 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
 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.
 \fBwgetparent\fR
 returns the parent WINDOW pointer for subwindows,
 or NULL for windows having no parent.


@@ -131,7 +140,7 @@ or NULL for windows having no parent.
 returns the top and bottom rows for the scrolling margin
 as set in \fBwsetscrreg\fP.
 .SH RETURN VALUE
 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
 .SH NOTES
 Both a macro and a function are provided for each name.
 .SH PORTABILITY