X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_opaque.3x;h=fa623eea1e9609b18c10177458c319803d7d6003;hb=refs%2Fheads%2Fmaster;hp=7a9e049c515b7e7539ab19794696b62e6751f255;hpb=ce7b402c144d2b6d3773ef5b42aad9daf1ad76fe;p=ncurses.git diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x index 7a9e049c..fa623eea 100644 --- a/man/curs_opaque.3x +++ b/man/curs_opaque.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2007,2009 Free Software Foundation, Inc. * +.\" 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 * .\" copy of this software and associated documentation files (the * @@ -26,122 +27,135 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_opaque.3x,v 1.7 2009/09/06 16:01:55 tom Exp $ -.TH curs_opaque 3X "" -.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 @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 -\fBis_cleared\fR, -\fBis_idlok\fR, -\fBis_idcok\fR, -\fBis_immedok\fR, -\fBis_keypad\fR, -\fBis_leaveok\fR, -\fBis_nodelay\fR, -\fBis_notimeout\fR, -\fBis_pad\fR, -\fBis_scrollok\fR, -\fBis_subwin\fR, -\fBis_syncok\fR - \fBcurses\fR 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 \fR -.sp -\fBbool is_cleared(const WINDOW *win);\fR -.br -\fBbool is_idcok(const WINDOW *win);\fR -.br -\fBbool is_idlok(const WINDOW *win);\fR -.br -\fBbool is_immedok(const WINDOW *win);\fR -.br -\fBbool is_keypad(const WINDOW *win);\fR -.br -\fBbool is_leaveok(const WINDOW *win);\fR -.br -\fBbool is_nodelay(const WINDOW *win);\fR -.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_subwin(const WINDOW *win);\fR -.br -\fBbool is_syncok(const WINDOW *win);\fR -.br -\fBWINDOW * wgetparent(const WINDOW *win);\fR -.br -\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR -.br +.nf +\fB#include +.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\fR is defined: -.TP 5 -\fBis_cleared\fR -returns the value set in \fBclearok\fR -.TP 5 -\fBis_idcok\fR -returns the value set in \fBidcok\fR -.TP 5 -\fBis_idlok\fR -returns the value set in \fBidlok\fR -.TP 5 -\fBis_immedok\fR -returns the value set in \fBimmedok\fR -.TP 5 -\fBis_keypad\fR -returns the value set in \fBkeypad\fR -.TP 5 -\fBis_leaveok\fR -returns the value set in \fBleaveok\fR -.TP 5 -\fBis_nodelay\fR -returns the value set in \fBnodelay\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_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 -\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. +\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). +.TP +\fBis_idcok\fP +returns the value set by \fB\%idcok\fP(3X). +.TP +\fBis_idlok\fP +returns the value set by \fB\%idlok\fP(3X). +.TP +\fBis_immedok\fP +returns the value set by \fB\%immedok\fP(3X). +.TP +\fBis_keypad\fP +returns the value set by \fB\%keypad\fP(3X). +.TP +\fBis_leaveok\fP +returns the value set by \fB\%leaveok\fP(3X). +.TP +\fBis_nodelay\fP +returns the value set by \fB\%nodelay\fP(3X). +.TP +\fBis_notimeout\fP +returns the value set by \fB\%notimeout\fP(3X). +.TP +\fBis_pad\fP +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 by \fB\%scrollok\fP(3X). +.TP +\fBis_subwin\fP +returns \fBTRUE\fP if the window is a subwindow, +that is, +it was created by \fB\%subwin\fP(3X) or \fB\%derwin\fP(3X). +.TP +\fBis_syncok\fP +returns the value set by \fB\%syncok\fP(3X). +.TP +\fBwgetdelay\fP +returns the delay timeout set by \fB\%wtimeout\fP(3X). +.TP +\fBwgetparent\fP +returns the parent \fI\%WINDOW\fP pointer for subwindows, +or \fBNULL\fP for windows having no parent. +.TP +\fBwgetscrreg\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 TRUE or FALSE, 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\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: +\fB\%curses\fP(3X), +\fB\%curs_inopts\fP(3X), +\fB\%curs_outopts\fP(3X), +\fB\%curs_threads\fP(3X), +\fB\%curs_window\fP(3X)