ncurses 6.2 - patch 20201205
[ncurses.git] / man / curs_sp_funcs.3x
index f736976228e1c931abdef5a8ddf23946615d49d9..76cfdad5a06fe12776af14490673664397d8955c 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2010-2015,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 2010-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_sp_funcs.3x,v 1.8 2017/03/25 18:08:33 tom Exp $
+.\" $Id: curs_sp_funcs.3x,v 1.21 2020/10/31 22:58:24 tom Exp $
 .TH curs_sp_funcs 3X ""
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
 .na
 .hy 0
 .SH NAME
@@ -54,12 +59,12 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint curs_set_sp(SCREEN*, int);\fR
 .br
-\fBint define_key_sp(SCREEN*, const char *, int);\fR
-.br
 \fBint def_prog_mode_sp(SCREEN*);\fR
 .br
 \fBint def_shell_mode_sp(SCREEN*);\fR
 .br
+\fBint define_key_sp(SCREEN*, const char *, int);\fR
+.br
 \fBint delay_output_sp(SCREEN*, int);\fR
 .br
 \fBint doupdate_sp(SCREEN*);\fR
@@ -68,25 +73,31 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint endwin_sp(SCREEN*);\fR
 .br
-\fBint erasechar_sp(SCREEN*);\fR
+\fBchar erasechar_sp(SCREEN*);\fR
 .br
-\fBint filter_sp(SCREEN*);\fR
+\fBint extended_color_content_sp(SCREEN *, int, int *, int *, int *);\fR
 .br
-\fBint find_pair_sp(SCREEN*, int, int);\fR
+\fBint extended_pair_content_sp(SCREEN*, int, int *, int *);\fR
 .br
-\fBint free_pair_sp(SCREEN*, int);\fR
+\fBint extended_slk_color_sp(SCREEN*, int);\fR
+.br
+\fBvoid filter_sp(SCREEN*);\fR
+.br
+\fBint find_pair_sp(SCREEN*, int, int);\fR
 .br
 \fBint flash_sp(SCREEN*);\fR
 .br
 \fBint flushinp_sp(SCREEN*);\fR
 .br
+\fBint free_pair_sp(SCREEN*, int);\fR
+.br
 \fBint get_escdelay_sp(SCREEN*);\fR
 .br
 \fBint getmouse_sp(SCREEN*, MEVENT*);\fR
 .br
 \fBWINDOW* getwin_sp(SCREEN*, FILE*);\fR
 .br
-\fBint halfdelay_sp(SCREEN*);\fR
+\fBint halfdelay_sp(SCREEN*, int);\fR
 .br
 \fBbool has_colors_sp(SCREEN*);\fR
 .br
@@ -100,18 +111,22 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint init_color_sp(SCREEN*, short, short, short, short);\fR
 .br
+\fBint init_extended_color_sp(SCREEN*, int, int, int, int);\fR
+.br
+\fBint init_extended_pair_sp(SCREEN*, int, int, int);\fR
+.br
 \fBint init_pair_sp(SCREEN*, short, short, short);\fR
 .br
 \fBint intrflush_sp(SCREEN*, WINDOW*, bool);\fR
 .br
-\fBbool isendwin_sp(SCREEN*);\fR
-.br
 \fBbool is_term_resized_sp(SCREEN*, int, int);\fR
 .br
-\fBchar* keybound_sp(SCREEN*, int, int);\fR
+\fBbool isendwin_sp(SCREEN*);\fR
 .br
 \fBint key_defined_sp(SCREEN*, const char *);\fR
 .br
+\fBchar* keybound_sp(SCREEN*, int, int);\fR
+.br
 \fBNCURSES_CONST char * keyname_sp(SCREEN*, int);\fR
 .br
 \fBint keyok_sp(SCREEN*, int, bool);\fR
@@ -134,7 +149,7 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBSCREEN* new_prescr(void);\fR
 .br
-\fBSCREEN* newterm_sp(SCREEN*, NCURSES_CONST char *, FILE *, FILE *);\fR
+\fBSCREEN* newterm_sp(SCREEN*, const char *, FILE *, FILE *);\fR
 .br
 \fBWINDOW* newwin_sp(SCREEN*, int, int, int, int);\fR
 .br
@@ -144,7 +159,7 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint noecho_sp(SCREEN*);\fR
 .br
-\fBint nofilter_sp(SCREEN*);\fR
+\fBvoid nofilter_sp(SCREEN*);\fR
 .br
 \fBint nonl_sp(SCREEN*);\fR
 .br
@@ -160,6 +175,8 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint reset_prog_mode_sp(SCREEN*);\fR
 .br
+\fBvoid reset_color_pairs_sp(SCREEN*);\fR
+.br
 \fBint reset_shell_mode_sp(SCREEN*);\fR
 .br
 \fBint resetty_sp(SCREEN*);\fR
@@ -168,8 +185,6 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint resizeterm_sp(SCREEN*, int, int);\fR
 .br
-\fBint restartterm_sp(SCREEN*, NCURSES_CONST char*, int, int *);\fR
-.br
 \fBint ripoffline_sp(SCREEN*, int, int (*)(WINDOW*, int));\fR
 .br
 \fBint savetty_sp(SCREEN*);\fR
@@ -180,21 +195,19 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint scr_set_sp(SCREEN*, const char *);\fR
 .br
-\fBTERMINAL* set_curterm_sp(SCREEN*, TERMINAL*);\fR
-.br
 \fBint set_escdelay_sp(SCREEN*, int);\fR
 .br
 \fBint set_tabsize_sp(SCREEN*, int);\fR
 .br
-\fBint slk_attroff_sp(SCREEN*, const chtype);\fR
-.br
-\fBint slk_attron_sp(SCREEN*, const chtype);\fR
-.br
 \fBint slk_attr_set_sp(SCREEN*, const attr_t, short, void*);\fR
 .br
 \fBint slk_attrset_sp(SCREEN*, const chtype);\fR
 .br
-\fBint slk_attr_sp(SCREEN*);\fR
+\fBint slk_attroff_sp(SCREEN*, const chtype);\fR
+.br
+\fBint slk_attron_sp(SCREEN*, const chtype);\fR
+.br
+\fBattr_t slk_attr_sp(SCREEN*);\fR
 .br
 \fBint slk_clear_sp(SCREEN*);\fR
 .br
@@ -202,7 +215,7 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint slk_init_sp(SCREEN*, int);\fR
 .br
-\fBint slk_label_sp(SCREEN*, int);\fR
+\fBchar* slk_label_sp(SCREEN*, int);\fR
 .br
 \fBint slk_noutrefresh_sp(SCREEN*);\fR
 .br
@@ -224,47 +237,45 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint typeahead_sp(SCREEN*, int);\fR
 .br
-\fBNCURSES_CONST char* unctrl_sp(SCREEN*, chtype);\fR
+\fBint unget_wch_sp(SCREEN*, const wchar_t);\fR
 .br
 \fBint ungetch_sp(SCREEN*, int);\fR
 .br
 \fBint ungetmouse_sp(SCREEN*,MEVENT *);\fR
 .br
-\fBint unget_wch_sp(SCREEN*, const wchar_t);\fR
-.br
 \fBint use_default_colors_sp(SCREEN*);\fR
 .br
 \fBvoid use_env_sp(SCREEN*, bool);\fR
 .br
-\fBvoid use_tioctl_sp (SCREEN *, bool)\fR
-.br
 \fBint use_legacy_coding_sp(SCREEN*, int);\fR
 .br
-\fBint vid_attr_sp(SCREEN*, attr_t, short, void *);\fR
+\fBvoid use_tioctl_sp(SCREEN *, bool);\fR
 .br
-\fBint vidattr_sp(SCREEN*, chtype);\fR
+\fBint vid_attr_sp(SCREEN*, attr_t, short, void *);\fR
 .br
 \fBint vid_puts_sp(SCREEN*, attr_t, short, void *, NCURSES_SP_OUTC);\fR
 .br
+\fBint vidattr_sp(SCREEN*, chtype);\fR
+.br
 \fBint vidputs_sp(SCREEN*, chtype, NCURSES_SP_OUTC);\fR
 .br
 \fBwchar_t* wunctrl_sp(SCREEN*, cchar_t *);\fR
 .sp
 \fB#include <form.h>\fR
 .sp
-\fBint new_form_sp(SCREEN*, FIELD **);\fR
+\fBFORM* new_form_sp(SCREEN*, FIELD **);\fR
 .sp
 \fB#include <menu.h>\fR
 .sp
-\fBint new_menu_sp(SCREEN*, ITEM **);\fR
+\fBMENU* new_menu_sp(SCREEN*, ITEM **);\fR
 .sp
 \fB#include <panel.h>\fR
 .sp
-\fBint ceiling_panel(SCREEN*);\fR
+\fBPANEL* ceiling_panel(SCREEN*);\fR
 .br
 \fBPANEL* ground_panel(SCREEN*);\fR
 .br
-\fBint update_panels_sp(SCREEN*);\fR
+\fBvoid update_panels_sp(SCREEN*);\fR
 .sp
 \fB#include <term.h>\fR
 .sp
@@ -272,21 +283,37 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint putp_sp(SCREEN*, const char *);\fR
 .br
-\fBint tgetflag_sp(SCREEN*, char *, const char *);\fR
+\fBint restartterm_sp(SCREEN*, NCURSES_CONST char*, int, int *);\fR
+.br
+\fBTERMINAL* set_curterm_sp(SCREEN*, TERMINAL*);\fR
 .br
 \fBint tgetent_sp(SCREEN*, char *, const char *);\fR
 .br
-\fBint tgetnum_sp(SCREEN*, NCURSES_CONST char *);\fR
+\fBint tgetflag_sp(SCREEN*, const char *);\fR
+.br
+\fBint tgetnum_sp(SCREEN*, const char *);\fR
+.br
+\fBchar* tgetstr_sp(SCREEN*, const char *, char **);\fR
 .br
-\fBchar* tgetstr_sp(SCREEN*, NCURSES_CONST char *, char **);\fR
+\fBchar* tgoto_sp(SCREEN*, const char *, int, int);\fR
 .br
-\fBint tigetflag_sp(SCREEN*, NCURSES_CONST char *);\fR
+\fBint tigetflag_sp(SCREEN*, const char *);\fR
 .br
-\fBint tigetnum_sp(SCREEN*, NCURSES_CONST char *);\fR
+\fBint tigetnum_sp(SCREEN*, const char *);\fR
 .br
-\fBchar* tigetstr_sp(SCREEN*, NCURSES_CONST char *);\fR
+\fBchar* tigetstr_sp(SCREEN*, const char *);\fR
+.br
+\fBchar* tiparm_sp(SCREEN*, const char *, ...);\fR
+.br
+/* may instead use 9 long parameters */
+.br
+\fBchar* tparm_sp(SCREEN*, const char *, ...);\fR
 .br
 \fBint tputs_sp(SCREEN*, const char *, int, NCURSES_SP_OUTC);\fR
+.sp
+\fB#include <unctrl.h>\fR
+.sp
+\fBNCURSES_CONST char* unctrl_sp(SCREEN*, chtype);\fR
 .ad
 .br
 .SH DESCRIPTION
@@ -338,7 +365,7 @@ to make it useful for checking if the extension is provided.
 NCURSES_SP_NAME
 The new functions are named using the macro \fINCURSES_SP_NAME\fP,
 which hides the actual implementation.
-Currently this adds a "_sp" suffix to the name of the unextended function.
+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