]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_sp_funcs.3x
ncurses 6.4 - patch 20230812
[ncurses.git] / man / curs_sp_funcs.3x
index d1465a024da868fe46aad1a7f0c45e54c0cfffed..5aa813d08f2a7245d0e943806e4976c5ae20bb8c 100644 (file)
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_sp_funcs.3x,v 1.31 2023/07/01 15:43:20 tom Exp $
-.TH curs_sp_funcs 3X 2023-07-01 "ncurses 6.4" "Library calls"
+.\" $Id: curs_sp_funcs.3x,v 1.32 2023/08/12 18:19:13 tom Exp $
+.TH curs_sp_funcs 3X 2023-08-12 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -42,228 +42,135 @@ curs_sp_funcs \- \fBcurses\fP screen-pointer extension
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .nf
+.na
 .sp
 \fBint alloc_pair_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR
-.br
 \fBint assume_default_colors_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR
-.br
 \fBint baudrate_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint beep_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBbool can_change_color_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint cbreak_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint color_content_sp(SCREEN* \fIsp\fB, short \fIcolor\fB, short* \fIr\fB, short* \fIg\fB, short* \fIb\fB);\fR
-.br
 \fBint curs_set_sp(SCREEN* \fIsp\fB, int \fIvisibility\fR);\fR
-.br
 \fBint def_prog_mode_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint def_shell_mode_sp(SCREEN* \fIsp\fB);\fR
 .sp
 \fBint define_key_sp(SCREEN* \fIsp\fB, const char * \fIdefinition\fB, int \fIkeycode\fB);\fR
-.br
 \fBint delay_output_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR
-.br
 \fBint doupdate_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint echo_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint endwin_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBchar erasechar_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint erasewchar_sp(SCREEN* \fIsp\fB, wchar_t *\fIch\fB);\fR
-.br
 \fBint extended_color_content_sp(SCREEN * \fIsp\fB, int \fIcolor\fB, int * \fIr\fB, int * \fIg\fB, int * \fIb\fB);\fR
-.br
 \fBint extended_pair_content_sp(SCREEN* \fIsp\fB, int \fIpair\fB, int * \fIfg\fB, int * \fIbg\fB);\fR
-.br
 \fBint extended_slk_color_sp(SCREEN* \fIsp\fB, int \fIpair\fB);\fR
 .sp
 \fBvoid filter_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint find_pair_sp(SCREEN* \fIsp\fB, int \fIfg\fB, int \fIbg\fB);\fR
-.br
 \fBint flash_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint flushinp_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint free_pair_sp(SCREEN* \fIsp\fB, int \fIpair\fB);\fR
-.br
 \fBint get_escdelay_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint getmouse_sp(SCREEN* \fIsp\fB, MEVENT* \fBevent\fB);\fR
-.br
 \fBWINDOW* getwin_sp(SCREEN* \fIsp\fB, FILE* \fIfilep\fB);\fR
-.br
 \fBint halfdelay_sp(SCREEN* \fIsp\fB, int \fItenths\fB);\fR
-.br
 \fBbool has_colors_sp(SCREEN* \fIsp\fB);\fR
 .sp
 \fBbool has_ic_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBbool has_il_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint has_key_sp(SCREEN* \fIsp\fB, int \fIch\fB);\fR
-.br
 \fBbool has_mouse_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint init_color_sp(SCREEN* \fIsp\fB, short \fIcolor\fB, short \fIr\fB, short \fIg\fB, short \fIb\fB);\fR
-.br
 \fBint init_extended_color_sp(SCREEN* \fIsp\fB, int \fIcolor\fB, int \fIr\fB, int \fIg\fB, int \fIb\fB);\fR
-.br
 \fBint init_extended_pair_sp(SCREEN* \fIsp\fB, int \fIpair\fB, int \fIfg\fB, int \fIbg\fB);\fR
-.br
 \fBint init_pair_sp(SCREEN* \fIsp\fB, short \fIpair\fB, short \fIfg\fB, short \fIbg\fB);\fR
-.br
 \fBint intrflush_sp(SCREEN* \fIsp\fB, WINDOW* \fIwin\fB, bool \fIbf\fB);\fR
-.br
-\fBbool is_term_resized_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR
+\fBint is_cbreak_sp(SCREEN* \fIsp\fB);\fR
 .sp
+\fBint is_echo_sp(SCREEN* \fIsp\fB);\fR
+\fBint is_nl_sp(SCREEN* \fIsp\fB);\fR
+\fBint is_raw_sp(SCREEN* \fIsp\fB);\fR
+\fBbool is_term_resized_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR
 \fBbool isendwin_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint key_defined_sp(SCREEN* \fIsp\fB, const char *\fIdefinition\fB);\fR
-.br
 \fBchar* keybound_sp(SCREEN* \fIsp\fB, int \fIkeycode\fB, int \fIcount\fB);\fR
-.br
-\fBNCURSES_CONST char * keyname_sp(SCREEN* \fIsp\fB, int \fIc\fB);\fR
-.br
+\fBNCURSES_CONST char* keyname_sp(SCREEN* \fIsp\fB, int \fIc\fB);\fR
 \fBint keyok_sp(SCREEN* \fIsp\fB, int \fIkeycode\fB, bool \fIenable\fB);\fR
-.br
 \fBchar killchar_sp(SCREEN* \fIsp\fB);\fR
-.br
+.sp
 \fBint killwchar_sp(SCREEN* \fIsp\fB, wchar_t *\fIch\fB);\fR
-.br
 \fBchar* longname_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint mcprint_sp(SCREEN* \fIsp\fB, char *\fIdata\fB, int \fIlen\fB);\fR
-.br
 \fBint mouseinterval_sp(SCREEN* \fIsp\fB, int \fIerval\fB);\fR
-.sp
 \fBmmask_t mousemask_sp(SCREEN* \fIsp\fB, mmask_t \fInewmask\fB, mmask_t *\fIoldmask\fB);\fR
-.br
 \fBint mvcur_sp(SCREEN* \fIsp\fB, int \fIoldrow\fB, int \fIoldcol\fB, int \fInewrow\fB, int \fInewcol\fB);\fR
-.br
 \fBint napms_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR
-.br
 \fBWINDOW* newpad_sp(SCREEN* \fIsp\fB, int \fInrows\fB, int \fIncols\fB);\fR
-.br
 \fBSCREEN* new_prescr(void);\fP
-.br
 \fBSCREEN* newterm_sp(SCREEN* \fIsp\fB, const char *\fItype\fB, FILE *\fIoutfd\fB, FILE *\fIinfd\fB);\fR
-.br
+.sp
 \fBWINDOW* newwin_sp(SCREEN* \fIsp\fB, int \fInlines\fB, int \fIncols\fB, int \fIbegin_y\fB, int \fIbegin_x\fB);\fR
-.br
 \fBint nl_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint nocbreak_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint noecho_sp(SCREEN* \fIsp\fB);\fR
-.sp
 \fBvoid nofilter_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint nonl_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBvoid noqiflush_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint noraw_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint pair_content_sp(SCREEN* \fIsp\fB, short \fIpair\fB, short* \fIfg\fB, short* \fIbg\fB);\fR
-.br
 \fBvoid qiflush_sp(SCREEN* \fIsp\fB);\fR
-.br
+.sp
 \fBint raw_sp(SCREEN* \fIsp\fB);\fR
-.br
-\fBint reset_prog_mode_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBvoid reset_color_pairs_sp(SCREEN* \fIsp\fB);\fR
-.br
+\fBint reset_prog_mode_sp(SCREEN* \fIsp\fB);\fR
 \fBint reset_shell_mode_sp(SCREEN* \fIsp\fB);\fR
-.sp
 \fBint resetty_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint resize_term_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR
-.br
 \fBint resizeterm_sp(SCREEN* \fIsp\fB, int \fIlines\fB, int \fIcolumns\fB);\fR
-.br
 \fBint ripoffline_sp(SCREEN* \fIsp\fB, int \fIline\fB, int (*\fIinit\fB)(WINDOW* \fIwin\fB, int \fIfmt\fB));\fR
-.br
 \fBint savetty_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint scr_init_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR
-.br
+.sp
 \fBint scr_restore_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR
-.br
 \fBint scr_set_sp(SCREEN* \fIsp\fB, const char *\fIfilename\fB);\fR
-.br
 \fBint set_escdelay_sp(SCREEN* \fIsp\fB, int \fIms\fB);\fR
-.br
 \fBint set_tabsize_sp(SCREEN* \fIsp\fB, int \fIcols\fB);\fR
-.sp
-\fBint slk_attr_set_sp(SCREEN* \fIsp\fB, const attr_t \fIattrs\fB, short \fIpair\fB, void*\fIopts\fB);\fR
-.br
 \fBint slk_attrset_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR
-.br
+\fBint slk_attr_set_sp(SCREEN* \fIsp\fB, const attr_t \fIattrs\fB, short \fIpair\fB, void*\fIopts\fB);\fR
 \fBint slk_attroff_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR
-.br
 \fBint slk_attron_sp(SCREEN* \fIsp\fB, const chtype \fIa\fB);\fR
-.br
 \fBattr_t slk_attr_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint slk_clear_sp(SCREEN* \fIsp\fB);\fR
-.br
+.sp
 \fBint slk_color_sp(SCREEN* \fIsp\fB, short \fIpair\fB);\fR
-.br
 \fBint slk_init_sp(SCREEN* \fIsp\fB, int \fIfmt\fB);\fR
-.br
 \fBchar* slk_label_sp(SCREEN* \fIsp\fB, int \fIlabnum\fB);\fR
-.br
 \fBint slk_noutrefresh_sp(SCREEN* \fIsp\fB);\fR
-.sp
 \fBint slk_refresh_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint slk_restore_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint slk_set_sp(SCREEN* \fIsp\fB, int \fIlabnum\fB, const char * \fIlabel\fB, int \fIfmt\fB);\fR
-.br
 \fBint slk_touch_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint start_color_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBattr_t term_attrs_sp(SCREEN* \fIsp\fB);\fR
-.br
+.sp
 \fBchtype termattrs_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBchar* termname_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBint typeahead_sp(SCREEN* \fIsp\fB, int \fIfd\fB);\fR
-.br
 \fBint unget_wch_sp(SCREEN* \fIsp\fB, const wchar_t \fIwch\fB);\fR
-.sp
 \fBint ungetch_sp(SCREEN* \fIsp\fB, int \fIch\fB);\fR
-.br
 \fBint ungetmouse_sp(SCREEN* \fIsp\fB,MEVENT * \fBevent\fB);\fR
-.br
 \fBint use_default_colors_sp(SCREEN* \fIsp\fB);\fR
-.br
 \fBvoid use_env_sp(SCREEN* \fIsp\fB, bool \fIbf\fB);\fR
-.br
 \fBint use_legacy_coding_sp(SCREEN* \fIsp\fB, int \fIlevel\fB);\fR
-.br
 \fBvoid use_tioctl_sp(SCREEN *\fIsp\fB, bool \fIbf\fB);\fR
-.br
+.sp
 \fBint vid_attr_sp(SCREEN* \fIsp\fB, attr_t \fIattrs\fB, short \fIpair\fB, void * \fIopts\fB);\fR
-.br
 \fBint vid_puts_sp(SCREEN* \fIsp\fB, attr_t \fIattrs\fB, short \fIpair\fB, void * \fIopts\fB, NCURSES_SP_OUTC \fIputc\fB);\fR
-.br
 \fBint vidattr_sp(SCREEN* \fIsp\fB, chtype \fIattrs\fB);\fR
-.br
 \fBint vidputs_sp(SCREEN* \fIsp\fB, chtype \fIattrs\fB, NCURSES_SP_OUTC \fIputc\fB);\fR
-.br
 \fBwchar_t* wunctrl_sp(SCREEN* \fIsp\fB, cchar_t *\fIch\fB);\fR
+.ad
 .sp
 \fB#include <form.h>\fP
 .sp
@@ -283,35 +190,24 @@ curs_sp_funcs \- \fBcurses\fP screen-pointer extension
 .sp
 \fB#include <term.h>\fP
 .sp
+.na
 \fBint del_curterm_sp(SCREEN* \fIsp\fB, TERMINAL *\fIoterm\fB);\fR
-.br
 \fBint putp_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB);\fR
-.br
 \fBint restartterm_sp(SCREEN* \fIsp\fB, NCURSES_CONST char*\fIterm\fB, int \fIfiledes\fB, int *\fIerrret\fB);\fR
-.br
 \fBTERMINAL* set_curterm_sp(SCREEN* \fIsp\fB, TERMINAL*\fInterm\fB);\fR
-.br
 \fBint tgetent_sp(SCREEN* \fIsp\fB, char *\fIbp\fB, const char *\fIname\fB);\fR
-.br
 \fBint tgetflag_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR
-.br
 \fBint tgetnum_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR
-.br
 \fBchar* tgetstr_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB, char **\fIarea\fB);\fR
-.br
 \fBchar* tgoto_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB, int \fIcol\fB, int \fIrow\fB);\fR
-.br
 \fBint tigetflag_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR
-.br
+.sp
 \fBint tigetnum_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR
-.br
 \fBchar* tigetstr_sp(SCREEN* \fIsp\fB, const char *\fIcapname\fB);\fR
-.br
-\fR/* may instead use 9 long parameters */\fP
-.br
+\fR/* may instead use 9 long parameters */\fR
 \fBchar* tparm_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB, ...);\fR
-.br
 \fBint tputs_sp(SCREEN* \fIsp\fB, const char *\fIstr\fB, int \fIaffcnt\fB, NCURSES_SP_OUTC \fIputc\fB);\fR
+.ad
 .sp
 \fB#include <unctrl.h>\fP
 .sp