X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_sp_funcs.3x.html;h=a83cece723b744b9e77b81e4081191490991e396;hp=ac189bd60fe4aaf95df60aaf34b1d0dcb8c210d9;hb=a90dd7b66fa711acd24d8181ea20e4f57d4b36cd;hpb=761e4f0825b330e970558e82a4bd638383914429 diff --git a/doc/html/man/curs_sp_funcs.3x.html b/doc/html/man/curs_sp_funcs.3x.html index ac189bd6..a83cece7 100644 --- a/doc/html/man/curs_sp_funcs.3x.html +++ b/doc/html/man/curs_sp_funcs.3x.html @@ -1,7 +1,7 @@ - + + + curs_sp_funcs 3x - + -

curs_sp_funcs 3x

-
+

curs_sp_funcs 3x

-
-curs_sp_funcs(3x)                                     curs_sp_funcs(3x)
+curs_sp_funcs(3x)                                            curs_sp_funcs(3x)
 
 
 
 
-
-

NAME

-       new_prescr - curses screen-pointer extension
+

NAME

+       curs_sp_funcs - curses screen-pointer extension
 
 
-
-

SYNOPSIS

-       #include <curses.h>
+

SYNOPSIS

+       #include <curses.h> #include <term.h>
 
+       int alloc_pair_sp(SCREEN*, int, int);
        int assume_default_colors_sp(SCREEN*, int, int);
        int baudrate_sp(SCREEN*);
        int beep_sp(SCREEN*);
@@ -71,20 +71,27 @@
        int doupdate_sp(SCREEN*);
        int echo_sp(SCREEN*);
        int endwin_sp(SCREEN*);
-       int erasechar_sp(SCREEN*);
-       int filter_sp(SCREEN*);
+       char erasechar_sp(SCREEN*);
+       int extended_color_content_sp(SCREEN *, int, int *, int *, int *);
+       int extended_pair_content_sp(SCREEN*, int, int *, int *);
+       int extended_slk_color_sp(SCREEN*, int);
+       void filter_sp(SCREEN*);
+       int find_pair_sp(SCREEN*, int, int);
+       int free_pair_sp(SCREEN*, int);
        int flash_sp(SCREEN*);
        int flushinp_sp(SCREEN*);
        int get_escdelay_sp(SCREEN*);
        int getmouse_sp(SCREEN*, MEVENT*);
        WINDOW* getwin_sp(SCREEN*, FILE*);
-       int halfdelay_sp(SCREEN*);
+       int halfdelay_sp(SCREEN*, int);
        bool has_colors_sp(SCREEN*);
        bool has_ic_sp(SCREEN*);
        bool has_il_sp(SCREEN*);
        int has_key_sp(SCREEN*, int);
        bool has_mouse_sp(SCREEN*);
        int init_color_sp(SCREEN*, short, short, short, short);
+       int init_extended_color_sp(SCREEN*, int, int, int, int);
+       int init_extended_pair_sp(SCREEN*, int, int, int);
        int init_pair_sp(SCREEN*, short, short, short);
        int intrflush_sp(SCREEN*, WINDOW*, bool);
        bool isendwin_sp(SCREEN*);
@@ -94,6 +101,7 @@
        NCURSES_CONST char * keyname_sp(SCREEN*, int);
        int keyok_sp(SCREEN*, int, bool);
        char killchar_sp(SCREEN*);
+       char* longname_sp(SCREEN*);
        int mcprint_sp(SCREEN*, char *, int);
        int mouseinterval_sp(SCREEN*, int);
        mmask_t mousemask_sp(SCREEN*, mmask_t, mmask_t *);
@@ -101,12 +109,12 @@
        int napms_sp(SCREEN*, int);
        WINDOW* newpad_sp(SCREEN*, int, int);
        SCREEN* new_prescr(void);
-       SCREEN* newterm_sp(SCREEN*, NCURSES_CONST char *, FILE *, FILE *);
+       SCREEN* newterm_sp(SCREEN*, const char *, FILE *, FILE *);
        WINDOW* newwin_sp(SCREEN*, int, int, int, int);
        int nl_sp(SCREEN*);
        int nocbreak_sp(SCREEN*);
        int noecho_sp(SCREEN*);
-       int nofilter_sp(SCREEN*);
+       void nofilter_sp(SCREEN*);
        int nonl_sp(SCREEN*);
        void noqiflush_sp(SCREEN*);
        int noraw_sp(SCREEN*);
@@ -131,11 +139,11 @@
        int slk_attron_sp(SCREEN*, const chtype);
        int slk_attr_set_sp(SCREEN*, const attr_t, short, void*);
        int slk_attrset_sp(SCREEN*, const chtype);
-       int slk_attr_sp((SCREEN*);
+       attr_t slk_attr_sp(SCREEN*);
        int slk_clear_sp(SCREEN*);
        int slk_color_sp(SCREEN*, short);
        int slk_init_sp(SCREEN*, int);
-       int slk_label_sp(SCREEN*, int);
+       char* slk_label_sp(SCREEN*, int);
        int slk_noutrefresh_sp(SCREEN*);
        int slk_refresh_sp(SCREEN*);
        int slk_restore_sp(SCREEN*);
@@ -152,6 +160,7 @@
        int unget_wch_sp(SCREEN*, const wchar_t);
        int use_default_colors_sp(SCREEN*);
        void use_env_sp(SCREEN*, bool);
+       void use_tioctl_sp(SCREEN *, bool);
        int use_legacy_coding_sp(SCREEN*, int);
        int vid_attr_sp(SCREEN*, attr_t, short, void *);
        int vidattr_sp(SCREEN*, chtype);
@@ -161,123 +170,123 @@
 
        #include <form.h>
 
-       int new_form_sp(SCREEN*, FIELD **);
+       FORM* new_form_sp(SCREEN*, FIELD **);
 
        #include <menu.h>
 
-       int new_menu_sp(SCREEN*, ITEM **);
+       MENU* new_menu_sp(SCREEN*, ITEM **);
 
        #include <panel.h>
 
-       int ceiling_panel(SCREEN*);
+       PANEL* ceiling_panel(SCREEN*);
        PANEL* ground_panel(SCREEN*);
-       int update_panels_sp(SCREEN*);
+       void update_panels_sp(SCREEN*);
 
        #include <term.h>
 
        int del_curterm_sp(SCREEN*, TERMINAL *);
        int putp_sp(SCREEN*, const char *);
-       int tgetflag_sp(SCREEN*, char *, const char *);
+       int tgetflag_sp(SCREEN*, const char *);
        int tgetent_sp(SCREEN*, char *, const char *);
-       int tgetnum_sp(SCREEN*, NCURSES_CONST char *);
-       char* tgetstr_sp(SCREEN*, NCURSES_CONST char *, char **);
-       int tigetflag_sp(SCREEN*, NCURSES_CONST char *);
-       int tigetnum_sp(SCREEN*, NCURSES_CONST char *);
-       char* tigetstr_sp(SCREEN*, NCURSES_CONST char *);
+       int tgetnum_sp(SCREEN*, const char *);
+       char* tgetstr_sp(SCREEN*, const char *, char **);
+       int tigetflag_sp(SCREEN*, const char *);
+       int tigetnum_sp(SCREEN*, const char *);
+       char* tigetstr_sp(SCREEN*, const char *);
        int tputs_sp(SCREEN*, const char *, int, NCURSES_SP_OUTC);
 
 
-
-

DESCRIPTION

-       This  implementation can be configured to provide a set of
-       functions which improve the  ability  to  manage  multiple
-       screens.  This feature can be added to any of the configu-
-       rations supported by  ncurses;  it  adds  new  entrypoints
-       without changing the meaning of any of the existing ones.
-
-   IMPROVED FUNCTIONS
-       Most  of  the functions are new versions of existing func-
-       tions.  A parameter is added at the front of the parameter
-       list.  It is a SCREEN pointer.
-
-       The  existing  functions all use the current screen, which
-       is a static variable.   The  extended  functions  use  the
-       specified screen, thereby reducing the number of variables
-       which must be modified to update multiple screens.
-
-   NEW FUNCTIONS
+

DESCRIPTION

+       This  implementation  can  be  configured to provide a set of functions
+       which improve the ability to manage multiple screens.  This feature can
+       be added to any of the configurations supported by ncurses; it adds new
+       entrypoints without changing the meaning of any of the existing ones.
+
+
+

IMPROVED FUNCTIONS

+       Most of the functions are new versions of existing functions.  A param-
+       eter  is  added  at  the  front  of the parameter list.  It is a SCREEN
+       pointer.
+
+       The existing functions all use the current screen, which  is  a  static
+       variable.  The extended functions use the specified screen, thereby re-
+       ducing the number of variables which must be modified to update  multi-
+       ple screens.
+
+
+

NEW FUNCTIONS

        Here are the new functions:
 
        ceiling_panel
-            this returns a pointer to the topmost  panel  in  the
-            given screen.
+            this returns a pointer to the topmost panel in the given screen.
 
        ground_panel
-            this  returns  a  pointer  to the lowest panel in the
-            given screen.
+            this returns a pointer to the lowest panel in the given screen.
 
        new_prescr
-            when creating a new screen, the library  uses  static
-            variables   which   have   been   preset,   e.g.,  by
-            use_env(3x), filter(3x), etc.  With the screen-point-
-            er extension, there are situations where it must cre-
-            ate a current screen before  the  unextended  library
-            does.   The new_prescr function is used internally to
-            handle these cases.  It is also provided as an entry-
-            point  to allow applications to customize the library
-            initialization.
+            when  creating  a  new  screen,  the library uses static variables
+            which have been preset, e.g.,  by  use_env(3x),  filter(3x),  etc.
+            With  the  screen-pointer extension, there are situations where it
+            must create a current screen before the unextended  library  does.
+            The  new_prescr function is used internally to handle these cases.
+            It is also provided as an entrypoint to allow applications to cus-
+            tomize the library initialization.
 
 
-
-

NOTES

+

NOTES

        This extension introduces some new names:
 
        NCURSES_SP_FUNCS
-            This is set to the library  patch-level  number.   In
-            the  unextended library, this is zero (0), to make it
-            useful for checking if the extension is provided.
+            This  is set to the library patch-level number.  In the unextended
+            library, this is zero (0), to make it useful for checking  if  the
+            extension is provided.
 
        NCURSES_SP_NAME
-            The new functions are named using  the  macro  NCURS-
-            ES_SP_NAME,  which  hides  the actual implementation.
-            Currently this adds a "_sp" suffix to the name of the
-            unextended  function.   This  manual page indexes the
-            extensions showing the full name.  However the proper
-            usage  of  these functions uses the macro, to provide
-            for the possibility of changing the naming convention
-            for specific library configurations.
+            The new functions are named using the macro NCURSES_SP_NAME, which
+            hides the actual implementation.  Currently this adds a "_sp" suf-
+            fix  to the name of the unextended function.  This manual page in-
+            dexes the extensions showing the full name.   However  the  proper
+            usage of these functions uses the macro, to provide for the possi-
+            bility of changing the naming convention for specific library con-
+            figurations.
 
        NCURSES_SP_OUTC
-            This  is  a  new  function-pointer type to use in the
-            screen-pointer functions  where  an  NCURSES_OUTC  is
-            used in the unextended library.
+            This  is  a new function-pointer type to use in the screen-pointer
+            functions where an NCURSES_OUTC is used in the unextended library.
 
        NCURSES_OUTC
-            This  is  a  function-pointer type used for the cases
-            where a function  passes  characters  to  the  output
-            stream, e.g., vidputs(3x).
+            This is a function-pointer type used for the cases where  a  func-
+            tion passes characters to the output stream, e.g., vidputs(3x).
 
 
-
-

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 ex-
-       tensions be conditioned using NCURSES_SP_FUNCS.
+

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  using NCURS-
+       ES_SP_FUNCS.
 
 
-
-

SEE ALSO

+

SEE ALSO

        curses(3x), curs_opaque(3x), curs_threads(3x).
 
 
 
-                                                      curs_sp_funcs(3x)
+                                                             curs_sp_funcs(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +