curs_opaque(3x) — Linux manual page

curs_opaque(3X)                                          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

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);

DESCRIPTION

       This  implementation  provides  functions which return properties
       set in the WINDOW structure, allowing it to be  “opaque”  if  the
       symbol NCURSES_OPAQUE is defined:

       is_cleared
            returns the value set in clearok(3X)

       is_idcok
            returns the value set in idcok(3X)

       is_idlok
            returns the value set in idlok(3X)

       is_immedok
            returns the value set in immedok(3X)

       is_keypad
            returns the value set in keypad(3X)

       is_leaveok
            returns the value set in leaveok(3X)

       is_nodelay
            returns the value set in nodelay(3X)

       is_notimeout
            returns the value set in notimeout(3X)

       is_pad
            returns TRUE if the window is a pad i.e., created by new‐
            pad(3X)

       is_scrollok
            returns the value set in scrollok(3X)

       is_subwin
            returns TRUE if the window is a subwindow, i.e., created by
            subwin(3X) or derwin(3X)

       is_syncok
            returns the value set in syncok(3X)

       wgetdelay
            returns the delay timeout as set in wtimeout(3X).

       wgetparent
            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.

RETURN VALUE

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

NOTES

       Both a macro and a function are provided for each name.

PORTABILITY

       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 us‐
       ing NCURSES_VERSION.

SEE ALSO

       curses(3X), curs_inopts(3X), curs_outopts(3X), curs_window(3X)

COLOPHON

       This page is part of the ncurses (new curses) project.  Informa‐
       tion about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                         curs_opaque(3X)