ncurses 6.2 - patch 20201205
[ncurses.git] / man / curs_sp_funcs.3x
index c869f7245779ef0898a84d0e2386b51800ce2412..76cfdad5a06fe12776af14490673664397d8955c 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2010-2018,2019 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.16 2019/04/13 16:41:08 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
@@ -36,7 +41,6 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-\fB#include <term.h>\fR
 .nf
 .sp
 \fBint alloc_pair_sp(SCREEN*, int, int);\fR
@@ -55,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
@@ -81,12 +85,12 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint find_pair_sp(SCREEN*, int, int);\fR
 .br
-\fBint free_pair_sp(SCREEN*, 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
@@ -115,14 +119,14 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .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
@@ -171,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
@@ -179,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
@@ -191,20 +195,18 @@ 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_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
@@ -235,28 +237,26 @@ 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
@@ -283,21 +283,37 @@ curs_sp_funcs \- \fBcurses\fR screen-pointer extension
 .br
 \fBint putp_sp(SCREEN*, const char *);\fR
 .br
-\fBint tgetflag_sp(SCREEN*, 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 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* tgoto_sp(SCREEN*, const char *, int, int);\fR
+.br
 \fBint tigetflag_sp(SCREEN*, const char *);\fR
 .br
 \fBint tigetnum_sp(SCREEN*, const char *);\fR
 .br
 \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
@@ -349,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