From e592e1c6db7697bae2296189e60c264dc031c5b6 Mon Sep 17 00:00:00 2001 From: Hartmut Holzgraefe Date: Thu, 13 Dec 2001 14:57:41 +0000 Subject: [PATCH] skeleton for upcoming ncurses dokumentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@64924 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/ncurses.xml | 2343 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2343 insertions(+) create mode 100644 functions/ncurses.xml diff --git a/functions/ncurses.xml b/functions/ncurses.xml new file mode 100644 index 0000000000..7ec1258907 --- /dev/null +++ b/functions/ncurses.xml @@ -0,0 +1,2343 @@ + + Ncurses terminal screen control functions + ncurses functions + + + + + + + + + + ncurses_can_change_color + Check if we can change terminals colors + + + Description + + + bool ncurses_can_change_color + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_cbreak + Switch of input buffering + + + Description + + + bool ncurses_cbreak + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_clear + Clear screen + + + Description + + + bool ncurses_clear + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_clrtobot + Clear screen from current position to bottom + + + Description + + + bool ncurses_clrtobot + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_clrtoeol + Clear screen from current position to end of line + + + Description + + + bool ncurses_clrtoeol + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_def_prog_mode + + + + Description + + + bool ncurses_def_prog_mode + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_def_shell_mode + + + + Description + + + bool ncurses_def_shell_mode + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_delch + Delete character at current position, move rest of line left + + + Description + + + bool ncurses_delch + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_deleteln + Delete line at current position, move rest of screen up + + + Description + + + bool ncurses_deleteln + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_doupdate + Write all prepared refreshes to terminal + + + Description + + + bool ncurses_doupdate + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_echo + Activate keyboard input echo + + + Description + + + bool ncurses_echo + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_erase + Erease terminal screen + + + Description + + + bool ncurses_erase + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_erasechar + Return current erase character + + + Description + + + bool ncurses_erasechar + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_flash + Flash terminal screen (visual bell) + + + Description + + + bool ncurses_flash + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_flushinp + Flush keyboard input buffer + + + Description + + + bool ncurses_flushinp + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_has_colors + Check if terminal has colors + + + Description + + + bool ncurses_has_colors + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_has_ic + Check for insert- and delete-capabilities + + + Description + + + bool ncurses_has_ic + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_has_il + Check for line insert- and delete-capabilities + + + Description + + + bool ncurses_has_il + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_inch + Get character and attribute at current position + + + Description + + + bool ncurses_inch + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_insertln + Insert a line, move rest of screen down + + + Description + + + bool ncurses_insertln + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_isendwin + Ncurses is in endwin mode, normal screen output may be performed + + + Description + + + bool ncurses_isendwin + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_killchar + Return current line kill character + + + Description + + + bool ncurses_killchar + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_nl + Translate newline and carriage return / line feed + + + Description + + + bool ncurses_nl + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_nocbreak + Switch terminal to cooked mode + + + Description + + + bool ncurses_nocbreak + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_noecho + Switch off keyboard input echo + + + Description + + + bool ncurses_noecho + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_nonl + Do not ranslate newline and carriage return / line feed + + + Description + + + bool ncurses_nonl + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_noraw + Switch terminal out of raw mode + + + Description + + + bool ncurses_noraw + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_raw + Switch terminal into raw mode + + + Description + + + bool ncurses_raw + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_resetty + Restore saved terminal state + + + Description + + + bool ncurses_resetty + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_savetty + Save terminal state + + + Description + + + bool ncurses_savetty + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_attr + + + + Description + + + bool ncurses_slk_attr + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_clear + + + + Description + + + bool ncurses_slk_clear + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_noutrefresh + + + + Description + + + bool ncurses_slk_noutrefresh + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_refresh + + + + Description + + + bool ncurses_slk_refresh + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_restore + + + + Description + + + bool ncurses_slk_restore + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_touch + + + + Description + + + bool ncurses_slk_touch + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_termattrs + Return a logical OR of all attribute flags supported by terminal + + + Description + + + bool ncurses_termattrs + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_use_default_colors + Assign terminal default colors to color id -1 + + + Description + + + bool ncurses_use_default_colors + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_addch + Add character at current position and advance cursor + + + Description + + + int ncurses_addch + int ch + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_addchnstr + Add attributed string with specified length at current position + + + Description + + + int ncurses_addchnstr + string s + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_addchstr + Add attributed string at current position + + + Description + + + int ncurses_addchstr + string s + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_addnstr + Add string with specified length at current position + + + Description + + + int ncurses_addnstr + string s + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_addstr + Output text at current position + + + Description + + + int ncurses_addstr + string text + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_assume_default_colors + Define default colors for color 0 + + + Description + + + int ncurses_assume_default_colors + int fg + int bg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_attroff + Turn off the given attributes + + + Description + + + int ncurses_attroff + int attributes + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_attron + Turn on the given attributes + + + Description + + + int ncurses_attron + int attributes + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_attrset + Set given attributes + + + Description + + + int ncurses_attrset + int attributes + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_baudrate + Return baudrate of terminal + + + Description + + + int ncurses_baudrate + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_beep + Let the terminal beep + + + Description + + + int ncurses_beep + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_bkgd + Set background property for terminal screen + + + Description + + + int ncurses_bkgd + int attrchar + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_border + Draw a border around the screen using attributed characters + + + Description + + + int ncurses_border + int left + int right + int top + int bottom + int tl_corner + int tr_corner + int bl_corner + int br_corner + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_color_set + Set fore- and background color + + + Description + + + int ncurses_color_set + int pair + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_curs_set + Set cursor state + + + Description + + + int ncurses_curs_set + int visibility + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_define_key + Define a keycode + + + Description + + + int ncurses_define_key + string definition + int keycode + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_delay_output + Delay output on terminal using padding characters + + + Description + + + int ncurses_delay_output + int milliseconds + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_delwin + Delete a ncurses window + + + Description + + + int ncurses_delwin + resource window + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_echochar + Single character output including refresh + + + Description + + + int ncurses_echochar + int character + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_end + Stop using ncurses, clean up the screen + + + Description + + + int ncurses_end + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_filter + + + + Description + + + int ncurses_filter + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_getch + Read a character from keyboard + + + Description + + + int ncurses_getch + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_halfdelay + Put terminal into halfdelay mode + + + Description + + + int ncurses_halfdelay + int tenth + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_has_key + Check for presence of a function key on terminal keyboard + + + Description + + + int ncurses_has_key + int keycode + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_hline + Draw a horizontal line at current position using an attributed character and max. n characters long + + + Description + + + int ncurses_hline + int charattr + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_init + Initialize ncurses + + + Description + + + int ncurses_init + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_init_color + Set new RGB value for color + + + Description + + + int ncurses_init_color + int color + int r + int g + int b + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_init_pair + Allocate a color pair + + + Description + + + int ncurses_init_pair + int pair + int fg + int bg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_insch + Insert character moving rest of line including character at current position + + + Description + + + int ncurses_insch + int character + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_insdelln + Insert lines before current line scrolling down (negative numbers delete and scroll up) + + + Description + + + int ncurses_insdelln + int count + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_insstr + Insert string at current position, moving rest of line right + + + Description + + + int ncurses_insstr + string text + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_instr + Read string from terminal screen + + + Description + + + int ncurses_instr + string buffer + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_keyok + Enable or disable a keycode + + + Description + + + int ncurses_keyok + int keycode + bool enable + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mouseinterval + Set timeout for mouse button clicks + + + Description + + + int ncurses_mouseinterval + int milliseconds + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_move + Move output position + + + Description + + + int ncurses_move + int y + int x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvaddch + Move current position and add character + + + Description + + + int ncurses_mvaddch + int y + int x + int c + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvaddchnstr + Move position and add attrributed string with specified length + + + Description + + + int ncurses_mvaddchnstr + int y + int x + string s + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvaddchstr + Move position and add attributed string + + + Description + + + int ncurses_mvaddchstr + int y + int x + string s + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvaddnstr + Move position and add string with specified length + + + Description + + + int ncurses_mvaddnstr + int y + int x + string s + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvaddstr + Move position and add string + + + Description + + + int ncurses_mvaddstr + int y + int x + string s + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvcur + Move cursor immediately + + + Description + + + int ncurses_mvcur + int old_y + int old_x + int new_y + int new_x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvdelch + Move position and delete character, shift rest of line left + + + Description + + + int ncurses_mvdelch + int y + int x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvgetch + Move position and get character at new position + + + Description + + + int ncurses_mvgetch + int y + int x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvhline + Set new position and draw a horizontal line using an attributed character and max. n characters long + + + Description + + + int ncurses_mvhline + int y + int x + int attrchar + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvinch + Move position and get attributed character at new position + + + Description + + + int ncurses_mvinch + int y + int x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvvline + Set new position and draw a vertical line using an attributed character and max. n characters long + + + Description + + + int ncurses_mvvline + int y + int x + int attrchar + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_mvwaddstr + Add string at new position in window + + + Description + + + int ncurses_mvwaddstr + resource window + int y + int x + string text + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_napms + Sleep + + + Description + + + int ncurses_napms + int milliseconds + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_newwin + Create a new window + + + Description + + + int ncurses_newwin + int rows + int cols + int y + int x + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_noqiflush + Do not flush on signal characters + + + Description + + + int ncurses_noqiflush + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_putp + + + + Description + + + int ncurses_putp + string text + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_qiflush + Flush on signal characters + + + Description + + + int ncurses_qiflush + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_refresh + Refresh screen + + + Description + + + int ncurses_refresh + int ch + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_scr_dump + Dump screen content to file + + + Description + + + int ncurses_scr_dump + string filename + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_scr_init + Initialize screen from file dump + + + Description + + + int ncurses_scr_init + string filename + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_scr_restore + Restore screen from file dump + + + Description + + + int ncurses_scr_restore + string filename + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_scr_set + Inherit screen from file dump + + + Description + + + int ncurses_scr_set + string filename + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_scrl + Scroll window content up or down without changing current position + + + Description + + + int ncurses_scrl + int count + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_attroff + + + + Description + + + int ncurses_slk_attroff + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_attron + + + + Description + + + int ncurses_slk_attron + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_attrset + + + + Description + + + int ncurses_slk_attrset + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_color + + + + Description + + + int ncurses_slk_color + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_slk_init + + + + Description + + + int ncurses_slk_init + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_standend + Stop using 'standout' attribute + + + Description + + + int ncurses_standend + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_standout + Start using 'standout' attribute + + + Description + + + int ncurses_standout + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_start_color + Start using colors + + + Description + + + int ncurses_start_color + + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_typeahead + Specify different filedescriptor for typeahead checking + + + Description + + + int ncurses_typeahead + int fd + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_ungetch + Put a character back into the input stream + + + Description + + + int ncurses_ungetch + int keycode + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_use_extended_names + Control use of extended names in terminfo descriptions + + + Description + + + int ncurses_use_extended_names + bool flag + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_vidattr + + + + Description + + + int ncurses_vidattr + int intarg + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_vline + Draw a vertical line at current position using an attributed character and max. n characters long + + + Description + + + int ncurses_vline + int charattr + int n + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_wrefresh + Refresh window on terminal screen + + + Description + + + int ncurses_wrefresh + resource window + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_bkgdset + Control screen background + + + Description + + + void ncurses_bkgdset + int attrchar + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_timeout + Set timeout for special key sequences + + + Description + + + void ncurses_timeout + int millisec + + + &warn.experimental.func; + + undocumented + + + + + + + ncurses_use_env + Control use of environment information about terminal size + + + Description + + + void ncurses_use_env + bool flag + + + &warn.experimental.func; + + undocumented + + + + + + + +