curs_opaque(3x) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

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 - obtain curses window properties

SYNOPSIS
       #include <ncursesw/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
       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  in‐
       stance,  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 by clearok(3X).

       is_idcok
              returns the value set by idcok(3X).

       is_idlok
              returns the value set by idlok(3X).

       is_immedok
              returns the value set by immedok(3X).

       is_keypad
              returns the value set by keypad(3X).

       is_leaveok
              returns the value set by leaveok(3X).

       is_nodelay
              returns the value set by nodelay(3X).

       is_notimeout
              returns the value set by notimeout(3X).

       is_pad returns TRUE if the window is a pad; that is, it was created  by
              newpad(3X).

       is_scrollok
              returns the value set by scrollok(3X).

       is_subwin
              returns  TRUE if the window is a subwindow, that is, it was cre‐
              ated by subwin(3X) or derwin(3X).

       is_syncok
              returns the value set by syncok(3X).

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

       wgetparent
              returns the parent WINDOW pointer for subwindows,  or  NULL  for
              windows having no parent.

       wgetscrreg
              stores  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 return TRUE or FALSE except as noted.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:

       box; cbp-1 | cbp-1 l | l .  ATTRIBUTE TYPE ATTRIBUTE VALUE = Availabil‐
       ity   library/ncurses = Stability Uncommitted

NOTES
       ncurses  provides  both  a C function and a preprocessor macro for each
       function documented in this page.

       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at:
       https://github.com/oracle/solaris-userland

       The original community source was downloaded from:
       https://invisible-mirror.net/archives/ncurses/cur‐
       rent/ncurses-6.5-20250614.tgz

       Further information about this software can be found on the open source
       community website at https://invisible-island.net/ncurses/.

EXTENSIONS
       These functions originated with ncurses.

PORTABILITY
       Applications employing ncurses extensions should condition their use on
       the visibility of the NCURSES_VERSION preprocessor macro.

       NetBSD  curses  since 10.1 (2024) supports wgetscr_reg.  It also imple‐
       ments getscr_reg, operating on stdscr.

SEE ALSO
       curses(3X),   curs_inopts(3X),   curs_outopts(3X),    curs_threads(3X),
       curs_window(3X)


ncurses 6.5                       2025-02-15                   curs_opaque(3x)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3