NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON

curs_opaque(3X)                                              curs_opaque(3X)

NAME         top

       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         top

       #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         top

       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
       is_idcok
            returns the value set in idcok
       is_idlok
            returns the value set in idlok
       is_immedok
            returns the value set in immedok
       is_keypad
            returns the value set in keypad
       is_leaveok
            returns the value set in leaveok
       is_nodelay
            returns the value set in nodelay
       is_notimeout
            returns the value set in notimeout
       is_pad
            returns TRUE if the window is a pad i.e., created by newpad
       is_scrollok
            returns the value set in scrollok
       is_subwin
            returns TRUE if the window is a subwindow, i.e., created by
            subwin or derwin
       is_syncok
            returns the value set in syncok
       wgetdelay
            returns the delay timeout as set in wtimeout.
       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         top

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

NOTES         top

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

PORTABILITY         top

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

SEE ALSO         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       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 
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05.  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)