X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_opaque.3x.html;h=6a1fcdfdd7c3856a73a12af9b9128b55e7eac27a;hp=43ab7c402319c084fa9beb21f79215ff75e66e4f;hb=HEAD;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_opaque.3x.html b/doc/html/man/curs_opaque.3x.html index 43ab7c40..50bb9ee6 100644 --- a/doc/html/man/curs_opaque.3x.html +++ b/doc/html/man/curs_opaque.3x.html @@ -1,6 +1,7 @@ - - -curs_opaque 3x - - + +curs_opaque 3x 2024-03-16 ncurses 6.5 Library calls + + -

curs_opaque 3x

curs_opaque 3x 2024-03-16 ncurses 6.5 Library calls

-curs_opaque(3x)                                                curs_opaque(3x)
+curs_opaque(3x)                  Library calls                 curs_opaque(3x)

NAME

-       is_cleared, is_idlok, is_idcok, is_immedok, is_keypad, is_leaveok,
-       is_nodelay, is_notimeout, is_pad, is_scrollok, is_subwin, is_syncok,
-       wgetdelay, wgetparent, wgetscrreg - curses window properties
+       is_cleared,  is_idlok,  is_idcok,  is_immedok,  is_keypad,  is_leaveok,
+       is_nodelay, is_notimeout, is_pad,  is_scrollok,  is_subwin,  is_syncok,
+       wgetdelay, wgetparent, wgetscrreg - obtain curses window properties

SYNOPSIS

        #include <curses.h>
 
-       bool is_cleared(const WINDOW *win);
-       bool is_idcok(const WINDOW *win);
-       bool is_idlok(const WINDOW *win);
-       bool is_immedok(const WINDOW *win);
-       bool is_keypad(const WINDOW *win);
-       bool is_leaveok(const WINDOW *win);
-       bool is_nodelay(const WINDOW *win);
-       bool is_notimeout(const WINDOW *win);
-       bool is_pad(const WINDOW *win);
-       bool is_scrollok(const WINDOW *win);
-       bool is_subwin(const WINDOW *win);
-       bool is_syncok(const WINDOW *win);
-       WINDOW * wgetparent(const WINDOW *win);
-       int wgetdelay(const WINDOW *win);
-       int wgetscrreg(const WINDOW *win, int *top, int *bottom);
+       bool is_cleared(const WINDOW *win);
+       bool is_idcok(const WINDOW *win);
+       bool is_idlok(const WINDOW *win);
+       bool is_immedok(const WINDOW *win);
+       bool is_keypad(const WINDOW *win);
+       bool is_leaveok(const WINDOW *win);
+       bool is_nodelay(const WINDOW *win);
+       bool is_notimeout(const WINDOW *win);
+       bool is_pad(const WINDOW *win);
+       bool is_scrollok(const WINDOW *win);
+       bool is_subwin(const WINDOW *win);
+       bool is_syncok(const WINDOW *win);
+
+       WINDOW * wgetparent(const WINDOW *win);
+       int wgetdelay(const WINDOW *win);
+       int wgetscrreg(const WINDOW *win, int *top, int *bottom);

DESCRIPTION

-       This  implementation  provides functions which return properties set in
-       the WINDOW structure, allowing it to be "opaque" if the  symbol  NCURS-
-       ES_OPAQUE is defined:
+       ncurses  provides functions returning properties of a WINDOW structure,
+       allowing  it  to  be  "opaque"   if   the   application   defines   the
+       NCURSES_OPAQUE  preprocessor  symbol.  Opacity in this sense means that
+       the members of struct 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.
 
        is_cleared
-            returns the value set in clearok
+              returns the value set by clearok(3x).
 
        is_idcok
-            returns the value set in idcok
+              returns the value set by idcok(3x).
 
        is_idlok
-            returns the value set in idlok
+              returns the value set by idlok(3x).
 
        is_immedok
-            returns the value set in immedok
+              returns the value set by immedok(3x).
 
        is_keypad
-            returns the value set in keypad
+              returns the value set by keypad(3x).
 
        is_leaveok
-            returns the value set in leaveok
+              returns the value set by leaveok(3x).
 
        is_nodelay
-            returns the value set in nodelay
+              returns the value set by nodelay(3x).
 
        is_notimeout
-            returns the value set in notimeout
+              returns the value set by notimeout(3x).
 
-       is_pad
-            returns TRUE if the window is a pad i.e., created by newpad
+       is_pad returns TRUE if the window is a pad; that is, it was created  by
+              newpad(3x).
 
        is_scrollok
-            returns the value set in scrollok
+              returns the value set by scrollok(3x).
 
        is_subwin
-            returns TRUE if the window is a subwindow, i.e., created by subwin
-            or derwin
+              returns  TRUE  if  the  window  is  a subwindow, that is, it was
+              created by subwin(3x) or derwin(3x).
 
        is_syncok
-            returns the value set in syncok
+              returns the value set by syncok(3x).
 
        wgetdelay
-            returns the delay timeout as set in wtimeout.
+              returns the delay timeout set by wtimeout(3x).
 
        wgetparent
-            returns the parent WINDOW pointer for subwindows, or NULL for win-
-            dows having no parent.
+              returns the parent WINDOW pointer for subwindows,  or  NULL  for
+              windows having no parent.
 
        wgetscrreg
-            returns the top and bottom rows for the scrolling margin as set in
-            wsetscrreg.
+              stores  the the top and bottom rows for the scrolling margin set
+              by wsetscrreg(3x) in the corresponding arguments, returning  ERR
+              upon failure and OK upon successful completion.

RETURN VALUE

-       These functions all return TRUE or FALSE, except as noted.
+       These functions return TRUE or FALSE except as noted.

NOTES

-       Both a macro and a function are provided for each name.
+       ncurses  provides  both  a C function and a preprocessor macro for each
+       function documented in this page.

PORTABILITY

-       These routines are specific to ncurses.  They  were  not  supported  on
+       These routines are specific to ncurses.  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_VER-
-       SION.
+       code   depending   on   ncurses   extensions   be   conditioned   using
+       NCURSES_VERSION.