diff options
Diffstat (limited to 'upstream/archlinux/man3/curs_opaque.3x')
| -rw-r--r-- | upstream/archlinux/man3/curs_opaque.3x | 212 |
1 files changed, 109 insertions, 103 deletions
diff --git a/upstream/archlinux/man3/curs_opaque.3x b/upstream/archlinux/man3/curs_opaque.3x index 2e57c0e2..a9b8d380 100644 --- a/upstream/archlinux/man3/curs_opaque.3x +++ b/upstream/archlinux/man3/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,129 +27,135 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.19 2023/03/11 20:40:58 tom Exp $ -.TH curs_opaque 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.na -.hy 0 +.\" $Id: curs_opaque.3x,v 1.43 2024/03/16 15:35:01 tom Exp $ +.TH curs_opaque 3X 2024-03-16 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBis_cleared\fP, -\fBis_idlok\fP, -\fBis_idcok\fP, -\fBis_immedok\fP, -\fBis_keypad\fP, -\fBis_leaveok\fP, -\fBis_nodelay\fP, -\fBis_notimeout\fP, -\fBis_pad\fP, -\fBis_scrollok\fP, -\fBis_subwin\fP, -\fBis_syncok\fP, -\fBwgetdelay\fP, -\fBwgetparent\fP, -\fBwgetscrreg\fP \- \fBcurses\fP window properties -.ad -.hy +\fB\%is_cleared\fP, +\fB\%is_idlok\fP, +\fB\%is_idcok\fP, +\fB\%is_immedok\fP, +\fB\%is_keypad\fP, +\fB\%is_leaveok\fP, +\fB\%is_nodelay\fP, +\fB\%is_notimeout\fP, +\fB\%is_pad\fP, +\fB\%is_scrollok\fP, +\fB\%is_subwin\fP, +\fB\%is_syncok\fP, +\fB\%wgetdelay\fP, +\fB\%wgetparent\fP, +\fB\%wgetscrreg\fP \- +obtain \fIcurses\fR window properties .SH SYNOPSIS -\fB#include <curses.h>\fP -.sp -\fBbool is_cleared(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_idcok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_idlok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_immedok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_keypad(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_leaveok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_nodelay(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_notimeout(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_pad(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_scrollok(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_subwin(const WINDOW *\fIwin\fB);\fR -.br -\fBbool is_syncok(const WINDOW *\fIwin\fB);\fR -.br -\fBWINDOW * wgetparent(const WINDOW *\fIwin\fB);\fR -.br -\fBint wgetdelay(const WINDOW *\fIwin\fB);\fR -.br -\fBint wgetscrreg(const WINDOW *\fIwin\fB, int *\fItop\fB, int *\fIbottom\fB);\fR -.br +.nf +\fB#include <curses.h> +.PP +\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\fP); +\fBint wgetdelay(const WINDOW *\fIwin\fP); +\fBint wgetscrreg(const WINDOW *\fIwin\fP, int *\fItop\fP, int *\fIbottom\fP); +.fi .SH DESCRIPTION -This implementation provides functions which return properties -set in the WINDOW structure, allowing it to be \*(``opaque\*('' if -the symbol \fBNCURSES_OPAQUE\fP is defined: -.TP 5 +\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 in \fBclearok\fP(3X) -.TP 5 +returns the value set by \fB\%clearok\fP(3X). +.TP \fBis_idcok\fP -returns the value set in \fBidcok\fP(3X) -.TP 5 +returns the value set by \fB\%idcok\fP(3X). +.TP \fBis_idlok\fP -returns the value set in \fBidlok\fP(3X) -.TP 5 +returns the value set by \fB\%idlok\fP(3X). +.TP \fBis_immedok\fP -returns the value set in \fBimmedok\fP(3X) -.TP 5 +returns the value set by \fB\%immedok\fP(3X). +.TP \fBis_keypad\fP -returns the value set in \fBkeypad\fP(3X) -.TP 5 +returns the value set by \fB\%keypad\fP(3X). +.TP \fBis_leaveok\fP -returns the value set in \fBleaveok\fP(3X) -.TP 5 +returns the value set by \fB\%leaveok\fP(3X). +.TP \fBis_nodelay\fP -returns the value set in \fBnodelay\fP(3X) -.TP 5 +returns the value set by \fB\%nodelay\fP(3X). +.TP \fBis_notimeout\fP -returns the value set in \fBnotimeout\fP(3X) -.TP 5 +returns the value set by \fB\%notimeout\fP(3X). +.TP \fBis_pad\fP -returns \fBTRUE\fP if the window is a pad -i.e., created by \fBnewpad\fP(3X) -.TP 5 +returns \fBTRUE\fP if the window is a pad; +that is, +it was created by \fB\%newpad\fP(3X). +.TP \fBis_scrollok\fP -returns the value set in \fBscrollok\fP(3X) -.TP 5 +returns the value set by \fB\%scrollok\fP(3X). +.TP \fBis_subwin\fP returns \fBTRUE\fP if the window is a subwindow, -i.e., created by \fBsubwin\fP(3X) or \fBderwin\fP(3X) -.TP 5 +that is, +it was created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X). +.TP \fBis_syncok\fP -returns the value set in \fBsyncok\fP(3X) -.TP 5 +returns the value set by \fB\%syncok\fP(3X). +.TP \fBwgetdelay\fP -returns the delay timeout as set in \fBwtimeout\fP(3X). -.TP 5 +returns the delay timeout set by \fB\%wtimeout\fP(3X). +.TP \fBwgetparent\fP -returns the parent WINDOW pointer for subwindows, -or NULL for windows having no parent. -.TP 5 +returns the parent \fI\%WINDOW\fP pointer for subwindows, +or \fBNULL\fP for windows having no parent. +.TP \fBwgetscrreg\fP -returns the top and bottom rows for the scrolling margin -as set in \fBwsetscrreg\fP. +stores the the top and bottom rows for the scrolling margin set by +\fB\%wsetscrreg\fP(3X) in the corresponding arguments, +returning \fBERR\fP upon failure and \fBOK\fP upon successful +completion. .SH RETURN VALUE -These functions all return \fBTRUE\fP or \fBFALSE\fP, except as noted. +These functions return \fBTRUE\fP or \fBFALSE\fP except as noted. .SH NOTES -Both a macro and a function are provided for each name. +\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 ncurses. +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 ncurses extensions -be conditioned using NCURSES_VERSION. +It is recommended that any code depending on \fI\%ncurses\fP extensions +be conditioned using \fB\%NCURSES_VERSION\fP. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_inopts\fP(3X), -\fBcurs_outopts\fP(3X), -\fBcurs_window\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_threads\fP(3X), +\fB\%curs_window\fP(3X) |