ncurses 6.5 - patch 20240922

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

diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x
index 3c206555b2e7c260bb2267cf1e7532b38e833164..fa623eea1e9609b18c10177458c319803d7d6003 100644 (file)
--- a/man/curs_opaque.3x
+++ b/man/curs_opaque.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2020-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2020-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 2007-2014,2015 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -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.43 2024/03/16 15:35:01 tom Exp $
+.TH curs_opaque 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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\%ncurses\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).
@@ -104,7 +118,7 @@ returns the value set by \fB\%notimeout\fP(3X).
 \fBis_pad\fP
 returns \fBTRUE\fP if the window is a pad;
 that is,
-it created by \fB\%newpad\fP(3X).
+it was created by \fB\%newpad\fP(3X).
 .TP
 \fBis_scrollok\fP
 returns the value set by \fB\%scrollok\fP(3X).
@@ -132,12 +146,12 @@ completion.
 .SH RETURN VALUE
 These functions return \fBTRUE\fP or \fBFALSE\fP except as noted.
 .SH NOTES
-\fIncurses\fP provides both a C function and a preprocessor macro for
+\fI\%ncurses\fP provides both a C function and a preprocessor macro for
 each function documented in this page.
 .SH PORTABILITY
-These routines are specific to \fIncurses\fP.
+These routines are specific to \fI\%ncurses\fP.
 They were not supported on Version 7, BSD or System V implementations.
-It is recommended that any code depending on \fIncurses\fP extensions
+It is recommended that any code depending on \fI\%ncurses\fP extensions
 be conditioned using \fB\%NCURSES_VERSION\fP.
 .SH SEE ALSO
 \fB\%curses\fP(3X),