ncurses 6.4 - patch 20231028

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

diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index 3c206555b2e7c260bb2267cf1e7532b38e833164..e2cc290dbff473152de99dcf6d07a6255cb49119 100644 (file)
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -27,12 +27,18 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_opaque.3x,v 1.35 2023/09/30 22:01:38 tom Exp $
-.TH curs_opaque 3X 2023-09-30 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_opaque.3x,v 1.38 2023/10/28 14:49:04 tom Exp $
+.TH curs_opaque 3X 2023-10-28 "ncurses 6.4" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fB\%is_cleared\fP,
 \fB\%is_idlok\fP,
@@ -52,30 +58,38 @@
 obtain \fIcurses\fR window properties
 .SH SYNOPSIS
 .nf
-\fB#include <curses.h>\fP
+\fB#include <curses.h>
 .PP
-\fBbool is_cleared(const WINDOW *\fIwin\fB);\fR
-\fBbool is_idcok(const WINDOW *\fIwin\fB);\fR
-\fBbool is_idlok(const WINDOW *\fIwin\fB);\fR
-\fBbool is_immedok(const WINDOW *\fIwin\fB);\fR
-\fBbool is_keypad(const WINDOW *\fIwin\fB);\fR
-\fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR
-\fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR
-\fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR
-\fBbool is_pad(const WINDOW *\fIwin\fB);\fR
-\fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR
-\fBbool is_subwin(const WINDOW *\fIwin\fB);\fR
-\fBbool is_syncok(const WINDOW *\fIwin\fB);\fR
+\fBbool is_cleared(const WINDOW *\fIwin\fP);
+\fBbool is_idcok(const WINDOW *\fIwin\fP);
+\fBbool is_idlok(const WINDOW *\fIwin\fP);
+\fBbool is_immedok(const WINDOW *\fIwin\fP);
+\fBbool is_keypad(const WINDOW *\fIwin\fP);
+\fBbool is_leaveok(const WINDOW *\fIwin\fP);
+\fBbool is_nodelay(const WINDOW *\fIwin\fP);
+\fBbool is_notimeout(const WINDOW *\fIwin\fP);
+\fBbool is_pad(const WINDOW *\fIwin\fP);
+\fBbool is_scrollok(const WINDOW *\fIwin\fP);
+\fBbool is_subwin(const WINDOW *\fIwin\fP);
+\fBbool is_syncok(const WINDOW *\fIwin\fP);
 .PP
-\fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR
-\fBint wgetdelay(const WINDOW *\fIwin\fB);\fR
-\fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR
+\fBWINDOW * wgetparent(const WINDOW *\fIwin\fP);
+\fBint wgetdelay(const WINDOW *\fIwin\fP);
+\fBint wgetscrreg(const WINDOW *\fIwin\fP, int *\fItop\fP, int *\fIbottom\fP);
 .fi
 .SH DESCRIPTION
 \fIncurses\fP provides functions returning properties of a
 \fI\%WINDOW\fP structure,
 allowing it to be \*(``opaque\*('' if
 the application defines the \fB\%NCURSES_OPAQUE\fP preprocessor symbol.
+\fIOpacity\fP in this sense means that the members of \fIstruct\fP data
+types are not directly accessible
+(for instance,
+through \*(``.\*('' or \*(``\->\*('' operators),
+but instead must be queried and/or set via library functions.
+Advantages of opacity include greater abstraction and improved
+management of concurrent accesses to data structures,
+keeping object states coherent.
 .TP
 \fBis_cleared\fP
 returns the value set by \fB\%clearok\fP(3X).