X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_sp_funcs.3x.html;h=d532d6cd7f8883af1d939122909b92ea0e9ec2e1;hb=HEAD;hp=5d366d708c4f54f1899123097b608ba95bf67d66;hpb=d79ff7b4d5f5ac63e7d9d7e76706d95a1ddb243c;p=ncurses.git diff --git a/doc/html/man/curs_sp_funcs.3x.html b/doc/html/man/curs_sp_funcs.3x.html index 5d366d70..4b84cd78 100644 --- a/doc/html/man/curs_sp_funcs.3x.html +++ b/doc/html/man/curs_sp_funcs.3x.html @@ -1,6 +1,6 @@ -curs_sp_funcs 3x 2023-07-01 ncurses 6.4 Library calls +curs_sp_funcs 3x 2024-05-11 ncurses 6.5 Library calls -

curs_sp_funcs 3x 2023-07-01 ncurses 6.4 Library calls

curs_sp_funcs 3x 2024-05-11 ncurses 6.5 Library calls

 curs_sp_funcs(3x)                Library calls               curs_sp_funcs(3x)
 
@@ -50,7 +47,7 @@

NAME

-       curs_sp_funcs - curses screen-pointer extension
+       curs_sp_funcs - curses screen-pointer extension

SYNOPSIS

@@ -63,7 +60,7 @@
        bool can_change_color_sp(SCREEN* sp);
        int cbreak_sp(SCREEN* sp);
        int color_content_sp(SCREEN* sp, short color, short* r, short* g, short* b);
-       int curs_set_sp(SCREEN* sp, int visibility);
+       int curs_set_sp(SCREEN* sp, int visibility);
        int def_prog_mode_sp(SCREEN* sp);
        int def_shell_mode_sp(SCREEN* sp);
 
@@ -73,7 +70,7 @@
        int echo_sp(SCREEN* sp);
        int endwin_sp(SCREEN* sp);
        char erasechar_sp(SCREEN* sp);
-       int erasewchar_sp(SCREEN* sp, wchar_t *ch);
+       int erasewchar_sp(SCREEN* sp, wchar_t *wc);
        int extended_color_content_sp(SCREEN * sp, int color, int * r, int * g, int * b);
        int extended_pair_content_sp(SCREEN* sp, int pair, int * fg, int * bg);
        int extended_slk_color_sp(SCREEN* sp, int pair);
@@ -84,99 +81,104 @@
        int flushinp_sp(SCREEN* sp);
        int free_pair_sp(SCREEN* sp, int pair);
        int get_escdelay_sp(SCREEN* sp);
-       int getmouse_sp(SCREEN* sp, MEVENT* event);
+       int getmouse_sp(SCREEN* sp, MEVENT* event);
        WINDOW* getwin_sp(SCREEN* sp, FILE* filep);
        int halfdelay_sp(SCREEN* sp, int tenths);
        bool has_colors_sp(SCREEN* sp);
 
        bool has_ic_sp(SCREEN* sp);
        bool has_il_sp(SCREEN* sp);
-       int has_key_sp(SCREEN* sp, int ch);
+       int has_key_sp(SCREEN* sp, int c);
        bool has_mouse_sp(SCREEN* sp);
        int init_color_sp(SCREEN* sp, short color, short r, short g, short b);
        int init_extended_color_sp(SCREEN* sp, int color, int r, int g, int b);
        int init_extended_pair_sp(SCREEN* sp, int pair, int fg, int bg);
        int init_pair_sp(SCREEN* sp, short pair, short fg, short bg);
        int intrflush_sp(SCREEN* sp, WINDOW* win, bool bf);
-       bool is_term_resized_sp(SCREEN* sp, int lines, int columns);
+       int is_cbreak_sp(SCREEN* sp);
 
+       int is_echo_sp(SCREEN* sp);
+       int is_nl_sp(SCREEN* sp);
+       int is_raw_sp(SCREEN* sp);
+       bool is_term_resized_sp(SCREEN* sp, int lines, int columns);
        bool isendwin_sp(SCREEN* sp);
        int key_defined_sp(SCREEN* sp, const char *definition);
        char* keybound_sp(SCREEN* sp, int keycode, int count);
-       NCURSES_CONST char * keyname_sp(SCREEN* sp, int c);
+       NCURSES_CONST char* keyname_sp(SCREEN* sp, int c);
        int keyok_sp(SCREEN* sp, int keycode, bool enable);
        char killchar_sp(SCREEN* sp);
-       int killwchar_sp(SCREEN* sp, wchar_t *ch);
+
+       int killwchar_sp(SCREEN* sp, wchar_t *wc);
        char* longname_sp(SCREEN* sp);
        int mcprint_sp(SCREEN* sp, char *data, int len);
        int mouseinterval_sp(SCREEN* sp, int erval);
-
        mmask_t mousemask_sp(SCREEN* sp, mmask_t newmask, mmask_t *oldmask);
        int mvcur_sp(SCREEN* sp, int oldrow, int oldcol, int newrow, int newcol);
        int napms_sp(SCREEN* sp, int ms);
        WINDOW* newpad_sp(SCREEN* sp, int nrows, int ncols);
        SCREEN* new_prescr(void);
        SCREEN* newterm_sp(SCREEN* sp, const char *type, FILE *outfd, FILE *infd);
+
        WINDOW* newwin_sp(SCREEN* sp, int nlines, int ncols, int begin_y, int begin_x);
        int nl_sp(SCREEN* sp);
        int nocbreak_sp(SCREEN* sp);
        int noecho_sp(SCREEN* sp);
-
        void nofilter_sp(SCREEN* sp);
        int nonl_sp(SCREEN* sp);
        void noqiflush_sp(SCREEN* sp);
        int noraw_sp(SCREEN* sp);
        int pair_content_sp(SCREEN* sp, short pair, short* fg, short* bg);
        void qiflush_sp(SCREEN* sp);
+
        int raw_sp(SCREEN* sp);
-       int reset_prog_mode_sp(SCREEN* sp);
        void reset_color_pairs_sp(SCREEN* sp);
+       int reset_prog_mode_sp(SCREEN* sp);
        int reset_shell_mode_sp(SCREEN* sp);
-
        int resetty_sp(SCREEN* sp);
        int resize_term_sp(SCREEN* sp, int lines, int columns);
        int resizeterm_sp(SCREEN* sp, int lines, int columns);
        int ripoffline_sp(SCREEN* sp, int line, int (*init)(WINDOW* win, int fmt));
        int savetty_sp(SCREEN* sp);
        int scr_init_sp(SCREEN* sp, const char *filename);
+
        int scr_restore_sp(SCREEN* sp, const char *filename);
        int scr_set_sp(SCREEN* sp, const char *filename);
        int set_escdelay_sp(SCREEN* sp, int ms);
        int set_tabsize_sp(SCREEN* sp, int cols);
-
-       int slk_attr_set_sp(SCREEN* sp, const attr_t attrs, short pair, void*opts);
        int slk_attrset_sp(SCREEN* sp, const chtype a);
+       int slk_attr_set_sp(SCREEN* sp, const attr_t attrs, short pair, void*opts);
        int slk_attroff_sp(SCREEN* sp, const chtype a);
        int slk_attron_sp(SCREEN* sp, const chtype a);
        attr_t slk_attr_sp(SCREEN* sp);
        int slk_clear_sp(SCREEN* sp);
+
        int slk_color_sp(SCREEN* sp, short pair);
        int slk_init_sp(SCREEN* sp, int fmt);
        char* slk_label_sp(SCREEN* sp, int labnum);
        int slk_noutrefresh_sp(SCREEN* sp);
-
        int slk_refresh_sp(SCREEN* sp);
        int slk_restore_sp(SCREEN* sp);
        int slk_set_sp(SCREEN* sp, int labnum, const char * label, int fmt);
        int slk_touch_sp(SCREEN* sp);
        int start_color_sp(SCREEN* sp);
        attr_t term_attrs_sp(SCREEN* sp);
+
        chtype termattrs_sp(SCREEN* sp);
        char* termname_sp(SCREEN* sp);
        int typeahead_sp(SCREEN* sp, int fd);
-       int unget_wch_sp(SCREEN* sp, const wchar_t wch);
-
-       int ungetch_sp(SCREEN* sp, int ch);
-       int ungetmouse_sp(SCREEN* sp,MEVENT * event);
+       int unget_wch_sp(SCREEN* sp, const wchar_t wc);
+       int ungetch_sp(SCREEN* sp, int c);
+       int ungetmouse_sp(SCREEN* sp, MEVENT* event);
        int use_default_colors_sp(SCREEN* sp);
        void use_env_sp(SCREEN* sp, bool bf);
        int use_legacy_coding_sp(SCREEN* sp, int level);
        void use_tioctl_sp(SCREEN *sp, bool bf);
+
        int vid_attr_sp(SCREEN* sp, attr_t attrs, short pair, void * opts);
        int vid_puts_sp(SCREEN* sp, attr_t attrs, short pair, void * opts, NCURSES_SP_OUTC putc);
        int vidattr_sp(SCREEN* sp, chtype attrs);
        int vidputs_sp(SCREEN* sp, chtype attrs, NCURSES_SP_OUTC putc);
-       wchar_t* wunctrl_sp(SCREEN* sp, cchar_t *ch);
+       wchar_t* wunctrl_sp(SCREEN* sp, cchar_t *wch);
 
        #include <form.h>
 
@@ -204,36 +206,37 @@
        char* tgetstr_sp(SCREEN* sp, const char *capname, char **area);
        char* tgoto_sp(SCREEN* sp, const char *capname, int col, int row);
        int tigetflag_sp(SCREEN* sp, const char *capname);
+
        int tigetnum_sp(SCREEN* sp, const char *capname);
        char* tigetstr_sp(SCREEN* sp, const char *capname);
-       /* may instead use 9 long parameters */
+       /* tparm_sp may use 9 long parameters rather than being variadic */
        char* tparm_sp(SCREEN* sp, const char *str, ...);
        int tputs_sp(SCREEN* sp, const char *str, int affcnt, NCURSES_SP_OUTC putc);
 
        #include <unctrl.h>
 
-       NCURSES_CONST char* unctrl_sp(SCREEN* sp, chtype c);
+       NCURSES_CONST char* unctrl_sp(SCREEN* sp, chtype ch);

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.
+       be added to any of the configurations supported by ncurses; it adds new
+       symbols 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
+

Improved Functions

+       Most of the functions  are  new  versions  of  existing  functions.   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 re-
-       ducing the number of variables which must be modified to update  multi-
-       ple screens.
+       variable.   The  extended  functions  use the specified screen, thereby
+       reducing the number of variables  which  must  be  modified  to  update
+       multiple screens.
 
 
-

NEW FUNCTIONS

New Functions

        Here are the new functions:
 
        ceiling_panel
@@ -248,8 +251,8 @@
             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.
+            It is also provided to allow  applications  to  customize  library
+            initialization.

NOTES

@@ -262,35 +265,36 @@
 
        NCURSES_SP_NAME
             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.
+            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.
 
        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.
 
        NCURSES_OUTC
-            This is a function-pointer type used for the cases where  a  func-
-            tion passes characters to the output stream, e.g., vidputs(3x).
+            This is a  function-pointer  type  used  for  the  cases  where  a
+            function   passes   characters   to   the   output  stream,  e.g.,
+            vidputs(3x).

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 NCURS-
-       ES_SP_FUNCS.
+       code   depending   on   ncurses   extensions   be   conditioned   using
+       NCURSES_SP_FUNCS.