From 7aad48f04695a2e97b89d6eb3606826a46426803 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Mon, 15 Jan 2007 18:54:01 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227319 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ncurses/functions/ncurses-addch.xml | 36 +++++----- .../ncurses/functions/ncurses-addchnstr.xml | 38 +++++----- .../ncurses/functions/ncurses-addchstr.xml | 36 +++++----- .../ncurses/functions/ncurses-addnstr.xml | 38 +++++----- .../ncurses/functions/ncurses-addstr.xml | 36 +++++----- .../ncurses-assume-default-colors.xml | 38 +++++----- .../ncurses/functions/ncurses-attroff.xml | 36 +++++----- .../ncurses/functions/ncurses-attron.xml | 36 +++++----- .../ncurses/functions/ncurses-attrset.xml | 36 +++++----- .../ncurses/functions/ncurses-baudrate.xml | 36 +++++----- reference/ncurses/functions/ncurses-beep.xml | 46 ++++++------ reference/ncurses/functions/ncurses-bkgd.xml | 36 +++++----- .../ncurses/functions/ncurses-bkgdset.xml | 36 +++++----- .../ncurses/functions/ncurses-border.xml | 68 +++++++++--------- .../functions/ncurses-bottom-panel.xml | 36 +++++----- .../functions/ncurses-can-change-color.xml | 40 +++++------ .../ncurses/functions/ncurses-cbreak.xml | 56 +++++++-------- reference/ncurses/functions/ncurses-clear.xml | 54 +++++++------- .../ncurses/functions/ncurses-clrtobot.xml | 52 +++++++------- .../ncurses/functions/ncurses-clrtoeol.xml | 50 ++++++------- .../functions/ncurses-color-content.xml | 42 ++++++----- .../ncurses/functions/ncurses-color-set.xml | 36 +++++----- .../ncurses/functions/ncurses-curs-set.xml | 36 +++++----- .../functions/ncurses-def-prog-mode.xml | 48 ++++++------- .../functions/ncurses-def-shell-mode.xml | 48 ++++++------- .../ncurses/functions/ncurses-define-key.xml | 38 +++++----- .../ncurses/functions/ncurses-del-panel.xml | 36 +++++----- .../functions/ncurses-delay-output.xml | 36 +++++----- reference/ncurses/functions/ncurses-delch.xml | 50 ++++++------- .../ncurses/functions/ncurses-deleteln.xml | 52 +++++++------- .../ncurses/functions/ncurses-delwin.xml | 36 +++++----- .../ncurses/functions/ncurses-doupdate.xml | 42 +++++------ reference/ncurses/functions/ncurses-echo.xml | 48 ++++++------- .../ncurses/functions/ncurses-echochar.xml | 36 +++++----- reference/ncurses/functions/ncurses-end.xml | 36 +++++----- reference/ncurses/functions/ncurses-erase.xml | 50 ++++++------- .../ncurses/functions/ncurses-erasechar.xml | 44 ++++++------ .../ncurses/functions/ncurses-filter.xml | 36 +++++----- reference/ncurses/functions/ncurses-flash.xml | 46 ++++++------ .../ncurses/functions/ncurses-flushinp.xml | 42 +++++------ reference/ncurses/functions/ncurses-getch.xml | 36 +++++----- .../ncurses/functions/ncurses-getmaxyx.xml | 50 ++++++------- .../ncurses/functions/ncurses-getmouse.xml | 12 ++-- reference/ncurses/functions/ncurses-getyx.xml | 40 +++++------ .../ncurses/functions/ncurses-halfdelay.xml | 36 +++++----- .../ncurses/functions/ncurses-has-colors.xml | 44 ++++++------ .../ncurses/functions/ncurses-has-ic.xml | 46 ++++++------ .../ncurses/functions/ncurses-has-il.xml | 46 ++++++------ .../ncurses/functions/ncurses-has-key.xml | 36 +++++----- .../ncurses/functions/ncurses-hide-panel.xml | 36 +++++----- reference/ncurses/functions/ncurses-hline.xml | 38 +++++----- reference/ncurses/functions/ncurses-inch.xml | 38 +++++----- .../ncurses/functions/ncurses-init-color.xml | 42 +++++------ .../ncurses/functions/ncurses-init-pair.xml | 40 +++++------ reference/ncurses/functions/ncurses-init.xml | 38 +++++----- reference/ncurses/functions/ncurses-insch.xml | 36 +++++----- .../ncurses/functions/ncurses-insdelln.xml | 36 +++++----- .../ncurses/functions/ncurses-insertln.xml | 38 +++++----- .../ncurses/functions/ncurses-insstr.xml | 36 +++++----- reference/ncurses/functions/ncurses-instr.xml | 44 ++++++------ .../ncurses/functions/ncurses-isendwin.xml | 52 +++++++------- reference/ncurses/functions/ncurses-keyok.xml | 38 +++++----- .../ncurses/functions/ncurses-keypad.xml | 38 +++++----- .../ncurses/functions/ncurses-killchar.xml | 44 ++++++------ .../ncurses/functions/ncurses-longname.xml | 10 +-- reference/ncurses/functions/ncurses-meta.xml | 38 +++++----- .../ncurses/functions/ncurses-mouse-trafo.xml | 40 +++++------ .../functions/ncurses-mouseinterval.xml | 36 +++++----- .../ncurses/functions/ncurses-mousemask.xml | 16 ++--- .../ncurses/functions/ncurses-move-panel.xml | 40 +++++------ reference/ncurses/functions/ncurses-move.xml | 38 +++++----- .../ncurses/functions/ncurses-mvaddch.xml | 40 +++++------ .../ncurses/functions/ncurses-mvaddchnstr.xml | 42 +++++------ .../ncurses/functions/ncurses-mvaddchstr.xml | 40 +++++------ .../ncurses/functions/ncurses-mvaddnstr.xml | 42 +++++------ .../ncurses/functions/ncurses-mvaddstr.xml | 40 +++++------ reference/ncurses/functions/ncurses-mvcur.xml | 42 +++++------ .../ncurses/functions/ncurses-mvdelch.xml | 38 +++++----- .../ncurses/functions/ncurses-mvgetch.xml | 38 +++++----- .../ncurses/functions/ncurses-mvhline.xml | 42 +++++------ .../ncurses/functions/ncurses-mvinch.xml | 38 +++++----- .../ncurses/functions/ncurses-mvvline.xml | 42 +++++------ .../ncurses/functions/ncurses-mvwaddstr.xml | 42 +++++------ reference/ncurses/functions/ncurses-napms.xml | 36 +++++----- .../ncurses/functions/ncurses-new-panel.xml | 36 +++++----- .../ncurses/functions/ncurses-newpad.xml | 38 +++++----- .../ncurses/functions/ncurses-newwin.xml | 58 +++++++-------- reference/ncurses/functions/ncurses-nl.xml | 36 +++++----- .../ncurses/functions/ncurses-nocbreak.xml | 52 +++++++------- .../ncurses/functions/ncurses-noecho.xml | 48 ++++++------- reference/ncurses/functions/ncurses-nonl.xml | 36 +++++----- .../ncurses/functions/ncurses-noqiflush.xml | 36 +++++----- reference/ncurses/functions/ncurses-noraw.xml | 58 +++++++-------- .../functions/ncurses-pair-content.xml | 40 +++++------ .../ncurses/functions/ncurses-panel-above.xml | 42 ++++++----- .../ncurses/functions/ncurses-panel-below.xml | 42 ++++++----- .../functions/ncurses-panel-window.xml | 36 +++++----- .../functions/ncurses-pnoutrefresh.xml | 48 ++++++------- .../ncurses/functions/ncurses-prefresh.xml | 48 ++++++------- reference/ncurses/functions/ncurses-putp.xml | 36 +++++----- .../ncurses/functions/ncurses-qiflush.xml | 36 +++++----- reference/ncurses/functions/ncurses-raw.xml | 58 +++++++-------- .../ncurses/functions/ncurses-refresh.xml | 36 +++++----- .../functions/ncurses-replace-panel.xml | 38 +++++----- .../functions/ncurses-reset-prog-mode.xml | 36 +++++----- .../functions/ncurses-reset-shell-mode.xml | 36 +++++----- .../ncurses/functions/ncurses-resetty.xml | 48 ++++++------- .../ncurses/functions/ncurses-savetty.xml | 48 ++++++------- .../ncurses/functions/ncurses-scr-dump.xml | 36 +++++----- .../ncurses/functions/ncurses-scr-init.xml | 36 +++++----- .../ncurses/functions/ncurses-scr-restore.xml | 36 +++++----- .../ncurses/functions/ncurses-scr-set.xml | 36 +++++----- reference/ncurses/functions/ncurses-scrl.xml | 36 +++++----- .../ncurses/functions/ncurses-show-panel.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-attr.xml | 38 +++++----- .../ncurses/functions/ncurses-slk-attroff.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-attron.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-attrset.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-clear.xml | 38 +++++----- .../ncurses/functions/ncurses-slk-color.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-init.xml | 54 +++++++------- .../functions/ncurses-slk-noutrefresh.xml | 36 +++++----- .../ncurses/functions/ncurses-slk-refresh.xml | 40 +++++------ .../ncurses/functions/ncurses-slk-restore.xml | 40 +++++------ .../ncurses/functions/ncurses-slk-set.xml | 40 +++++------ .../ncurses/functions/ncurses-slk-touch.xml | 40 +++++------ .../ncurses/functions/ncurses-standend.xml | 36 +++++----- .../ncurses/functions/ncurses-standout.xml | 36 +++++----- .../ncurses/functions/ncurses-start-color.xml | 36 +++++----- .../ncurses/functions/ncurses-termattrs.xml | 36 +++++----- .../ncurses/functions/ncurses-termname.xml | 10 +-- .../ncurses/functions/ncurses-timeout.xml | 36 +++++----- .../ncurses/functions/ncurses-top-panel.xml | 36 +++++----- .../ncurses/functions/ncurses-typeahead.xml | 36 +++++----- .../ncurses/functions/ncurses-ungetch.xml | 36 +++++----- .../ncurses/functions/ncurses-ungetmouse.xml | 12 ++-- .../functions/ncurses-update-panels.xml | 36 +++++----- .../functions/ncurses-use-default-colors.xml | 36 +++++----- .../ncurses/functions/ncurses-use-env.xml | 10 +-- .../functions/ncurses-use-extended-names.xml | 36 +++++----- .../ncurses/functions/ncurses-vidattr.xml | 36 +++++----- reference/ncurses/functions/ncurses-vline.xml | 38 +++++----- .../ncurses/functions/ncurses-waddch.xml | 38 +++++----- .../ncurses/functions/ncurses-waddstr.xml | 40 +++++------ .../ncurses/functions/ncurses-wattroff.xml | 38 +++++----- .../ncurses/functions/ncurses-wattron.xml | 38 +++++----- .../ncurses/functions/ncurses-wattrset.xml | 38 +++++----- .../ncurses/functions/ncurses-wborder.xml | 72 +++++++++---------- .../ncurses/functions/ncurses-wclear.xml | 36 +++++----- .../ncurses/functions/ncurses-wcolor-set.xml | 38 +++++----- .../ncurses/functions/ncurses-werase.xml | 36 +++++----- .../ncurses/functions/ncurses-wgetch.xml | 36 +++++----- .../ncurses/functions/ncurses-whline.xml | 40 +++++------ .../functions/ncurses-wmouse-trafo.xml | 42 ++++++----- reference/ncurses/functions/ncurses-wmove.xml | 40 +++++------ .../functions/ncurses-wnoutrefresh.xml | 36 +++++----- .../ncurses/functions/ncurses-wrefresh.xml | 36 +++++----- .../ncurses/functions/ncurses-wstandend.xml | 36 +++++----- .../ncurses/functions/ncurses-wstandout.xml | 36 +++++----- .../ncurses/functions/ncurses-wvline.xml | 40 +++++------ 160 files changed, 3104 insertions(+), 3184 deletions(-) diff --git a/reference/ncurses/functions/ncurses-addch.xml b/reference/ncurses/functions/ncurses-addch.xml index a9a2d00f75..76db4ba336 100644 --- a/reference/ncurses/functions/ncurses-addch.xml +++ b/reference/ncurses/functions/ncurses-addch.xml @@ -1,23 +1,23 @@ - + - - - ncurses_addch - Add character at current position and advance cursor - - - Description - - intncurses_addch - intch - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_addch + Add character at current position and advance cursor + + + Description + + intncurses_addch + intch + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_addchnstr - Add attributed string with specified length at current position - - - Description - - intncurses_addchnstr - strings - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_addchnstr + Add attributed string with specified length at current position + + + Description + + intncurses_addchnstr + strings + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_addchstr - Add attributed string at current position - - - Description - - intncurses_addchstr - strings - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_addchstr + Add attributed string at current position + + + Description + + intncurses_addchstr + strings + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_addnstr - Add string with specified length at current position - - - Description - - intncurses_addnstr - strings - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_addnstr + Add string with specified length at current position + + + Description + + intncurses_addnstr + strings + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_addstr - Output text at current position - - - Description - - intncurses_addstr - stringtext - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_addstr + Output text at current position + + + Description + + intncurses_addstr + stringtext + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_assume_default_colors - Define default colors for color 0 - - - Description - - intncurses_assume_default_colors - intfg - intbg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_assume_default_colors + Define default colors for color 0 + + + Description + + intncurses_assume_default_colors + intfg + intbg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_attroff - Turn off the given attributes - - - Description - - intncurses_attroff - intattributes - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_attroff + Turn off the given attributes + + + Description + + intncurses_attroff + intattributes + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_attron - Turn on the given attributes - - - Description - - intncurses_attron - intattributes - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_attron + Turn on the given attributes + + + Description + + intncurses_attron + intattributes + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_attrset - Set given attributes - - - Description - - intncurses_attrset - intattributes - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_attrset + Set given attributes + + + Description + + intncurses_attrset + intattributes + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_baudrate - Returns baudrate of terminal - - - Description - - intncurses_baudrate - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_baudrate + Returns baudrate of terminal + + + Description + + intncurses_baudrate + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_beep - Let the terminal beep - - - Description - - intncurses_beep - - - &warn.experimental.func; - - ncurses_beep sends an audible alert (bell) - and if its not possible flashes the screen. - &return.success; - - - See also ncurses_flash - - - + + + ncurses_beep + Let the terminal beep + + + Description + + intncurses_beep + + + &warn.experimental.func; + + ncurses_beep sends an audible alert (bell) + and if its not possible flashes the screen. + &return.success; + + + See also ncurses_flash + + + + - - - ncurses_bkgd - Set background property for terminal screen - - - Description - - intncurses_bkgd - intattrchar - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_bkgd + Set background property for terminal screen + + + Description + + intncurses_bkgd + intattrchar + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_bkgdset - Control screen background - - - Description - - voidncurses_bkgdset - intattrchar - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_bkgdset + Control screen background + + + Description + + voidncurses_bkgdset + intattrchar + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_border - Draw a border around the screen using attributed characters - - - Description - - intncurses_border - intleft - intright - inttop - intbottom - inttl_corner - inttr_corner - intbl_corner - intbr_corner - - &warn.experimental.func; - - ncurses_border draws the specified lines and - corners around the main window. Each parameter expects 0 to draw - a line and 1 to skip it. The corners are top left, top right, - bottom left and bottom right. - - - Use ncurses_wborder for borders around subwindows! - - - See also ncurses_wborder. - - - + + + ncurses_border + Draw a border around the screen using attributed characters + + + Description + + intncurses_border + intleft + intright + inttop + intbottom + inttl_corner + inttr_corner + intbl_corner + intbr_corner + + &warn.experimental.func; + + ncurses_border draws the specified lines and + corners around the main window. Each parameter expects 0 to draw + a line and 1 to skip it. The corners are top left, top right, + bottom left and bottom right. + + + Use ncurses_wborder for borders around subwindows! + + + See also ncurses_wborder. + + + + - - - ncurses_bottom_panel - - Moves a visible panel to the bottom of the stack - - - - Description - - intncurses_bottom_panel - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_bottom_panel + Moves a visible panel to the bottom of the stack + + + Description + + intncurses_bottom_panel + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_can_change_color - Check if we can change terminals colors - - - Description - - boolncurses_can_change_color - - - &warn.experimental.func; - - The function ncurses_can_change_color returns - &true; or &false;, depending on whether the terminal has color - capabilities and whether the programmer can change the colors. - - - + + + ncurses_can_change_color + Check if we can change terminals colors + + + Description + + boolncurses_can_change_color + + + &warn.experimental.func; + + The function ncurses_can_change_color returns + &true; or &false;, depending on whether the terminal has color + capabilities and whether the programmer can change the colors. + + + + - - - ncurses_cbreak - Switch of input buffering - - - Description - - boolncurses_cbreak - - - &warn.experimental.func; - - ncurses_cbreak disables line buffering and - character processing (interrupt and flow control characters are - unaffected), making characters typed by the user immediately - available to the program. - - - ncurses_cbreak returns &true; or NCURSES_ERR - if any error occurred. - - - See also: ncurses_nocbreak - - - + + + ncurses_cbreak + Switch of input buffering + + + Description + + boolncurses_cbreak + + + &warn.experimental.func; + + ncurses_cbreak disables line buffering and + character processing (interrupt and flow control characters are + unaffected), making characters typed by the user immediately + available to the program. + + + ncurses_cbreak returns &true; or NCURSES_ERR + if any error occurred. + + + See also: ncurses_nocbreak + + + + - - - ncurses_clear - Clear screen - - - Description - - boolncurses_clear - - - &warn.experimental.func; - - ncurses_clear clears the screen completely - without setting blanks. &return.success; - - - Note: ncurses_clear clears the screen without - setting blanks, which have the current background rendition. To - clear screen with blanks, use ncurses_erase. - - - See also ncurses_erase. - - - + + + ncurses_clear + Clear screen + + + Description + + boolncurses_clear + + + &warn.experimental.func; + + ncurses_clear clears the screen completely + without setting blanks. &return.success; + + + Note: ncurses_clear clears the screen without + setting blanks, which have the current background rendition. To + clear screen with blanks, use ncurses_erase. + + + See also ncurses_erase. + + + + - - - ncurses_clrtobot - Clear screen from current position to bottom - - - Description - - boolncurses_clrtobot - - - &warn.experimental.func; - - ncurses_clrtobot erases all lines from cursor - to end of screen and creates blanks. Blanks created by - ncurses_clrtobot have the current background - rendition. &return.success; - - - See also - ncurses_clear, and - ncurses_clrtoeol - - - + + + ncurses_clrtobot + Clear screen from current position to bottom + + + Description + + boolncurses_clrtobot + + + &warn.experimental.func; + + ncurses_clrtobot erases all lines from cursor + to end of screen and creates blanks. Blanks created by + ncurses_clrtobot have the current background + rendition. &return.success; + + + See also + ncurses_clear, and + ncurses_clrtoeol + + + + - - - ncurses_clrtoeol - Clear screen from current position to end of line - - - Description - - boolncurses_clrtoeol - - - &warn.experimental.func; - - ncurses_clrtoeol erases the current line from - cursor position to the end. Blanks created by - ncurses_clrtoeol have the current background - rendition. &return.success; - - - See also ncurses_clear, and - ncurses_clrtobot - - - + + + ncurses_clrtoeol + Clear screen from current position to end of line + + + Description + + boolncurses_clrtoeol + + + &warn.experimental.func; + + ncurses_clrtoeol erases the current line from + cursor position to the end. Blanks created by + ncurses_clrtoeol have the current background + rendition. &return.success; + + + See also ncurses_clear, and + ncurses_clrtobot + + + + - - - ncurses_color_content - - Gets the RGB value for color - - - - Description - - intncurses_color_content - intcolor - intr - intg - intb - - - &warn.undocumented.func; - - - + + + ncurses_color_content + Gets the RGB value for color + + + Description + + intncurses_color_content + intcolor + intr + intg + intb + + + &warn.undocumented.func; + + + + - - - ncurses_color_set - Set fore- and background color - - - Description - - intncurses_color_set - intpair - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_color_set + Set fore- and background color + + + Description + + intncurses_color_set + intpair + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_curs_set - Set cursor state - - - Description - - intncurses_curs_set - intvisibility - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_curs_set + Set cursor state + + + Description + + intncurses_curs_set + intvisibility + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_def_prog_mode - Saves terminals (program) mode - - - Description - - boolncurses_def_prog_mode - - - &warn.experimental.func; - - ncurses_def_prog_mode saves the current - terminal modes for program (in curses) for use by - ncurses_reset_prog_mode. Returns &false; on - success, otherwise &true;. - - - See also: ncurses_reset_prog_mode - - - + + + ncurses_def_prog_mode + Saves terminals (program) mode + + + Description + + boolncurses_def_prog_mode + + + &warn.experimental.func; + + ncurses_def_prog_mode saves the current + terminal modes for program (in curses) for use by + ncurses_reset_prog_mode. Returns &false; on + success, otherwise &true;. + + + See also: ncurses_reset_prog_mode + + + + - - - ncurses_def_shell_mode - Saves terminals (shell) mode - - - Description - - boolncurses_def_shell_mode - - - &warn.experimental.func; - - ncurses_def_shell_mode saves the current - terminal modes for shell (not in curses) for use by - ncurses_reset_shell_mode. Returns &false; on - success, otherwise &true;. - - - See also: ncurses_reset_shell_mode - - - + + + ncurses_def_shell_mode + Saves terminals (shell) mode + + + Description + + boolncurses_def_shell_mode + + + &warn.experimental.func; + + ncurses_def_shell_mode saves the current + terminal modes for shell (not in curses) for use by + ncurses_reset_shell_mode. Returns &false; on + success, otherwise &true;. + + + See also: ncurses_reset_shell_mode + + + + - - - ncurses_define_key - Define a keycode - - - Description - - intncurses_define_key - stringdefinition - intkeycode - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_define_key + Define a keycode + + + Description + + intncurses_define_key + stringdefinition + intkeycode + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_del_panel - - Remove panel from the stack and delete it (but not the associated window) - - - - Description - - boolncurses_del_panel - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_del_panel + Remove panel from the stack and delete it (but not the associated window) + + + Description + + boolncurses_del_panel + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_delay_output - Delay output on terminal using padding characters - - - Description - - intncurses_delay_output - intmilliseconds - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_delay_output + Delay output on terminal using padding characters + + + Description + + intncurses_delay_output + intmilliseconds + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_delch - Delete character at current position, move rest of line left - - - Description - - boolncurses_delch - - - &warn.experimental.func; - - ncurses_delch deletes the character under - the cursor. All characters to the right of the cursor on the same - line are moved to the left one position and the last character on - the line is filled with a blank. The cursor position does - not change. Returns &false; on success, otherwise &true;. - - - See also: ncurses_deleteln - - - + + + ncurses_delch + Delete character at current position, move rest of line left + + + Description + + boolncurses_delch + + + &warn.experimental.func; + + ncurses_delch deletes the character under + the cursor. All characters to the right of the cursor on the same + line are moved to the left one position and the last character on + the line is filled with a blank. The cursor position does + not change. Returns &false; on success, otherwise &true;. + + + See also: ncurses_deleteln + + + + - - - ncurses_deleteln - Delete line at current position, move rest of screen up - - - Description - - boolncurses_deleteln - - - &warn.experimental.func; - - ncurses_deleteln deletes the current line under - cursorposition. All lines below the current line are moved up one - line. - The bottom line of window is cleared. Cursor position does not - change. - Returns &false; on success, otherwise &true;. - - - See also: ncurses_delch - - - + + + ncurses_deleteln + Delete line at current position, move rest of screen up + + + Description + + boolncurses_deleteln + + + &warn.experimental.func; + + ncurses_deleteln deletes the current line under + cursorposition. All lines below the current line are moved up one + line. + The bottom line of window is cleared. Cursor position does not + change. + Returns &false; on success, otherwise &true;. + + + See also: ncurses_delch + + + + - - - ncurses_delwin - Delete a ncurses window - - - Description - - boolncurses_delwin - resourcewindow - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_delwin + Delete a ncurses window + + + Description + + boolncurses_delwin + resourcewindow + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_doupdate - Write all prepared refreshes to terminal - - - Description - - boolncurses_doupdate - - - &warn.experimental.func; - - ncurses_doupdate compares the virtual screen to the - physical screen and updates the physical screen. This way is more - effective than using multiple refresh calls. - &return.success; - - - + + + ncurses_doupdate + Write all prepared refreshes to terminal + + + Description + + boolncurses_doupdate + + + &warn.experimental.func; + + ncurses_doupdate compares the virtual screen to the + physical screen and updates the physical screen. This way is more + effective than using multiple refresh calls. + &return.success; + + + + - - - ncurses_echo - Activate keyboard input echo - - - Description - - boolncurses_echo - - - &warn.experimental.func; - - ncurses_echo enables echo mode. - All characters typed by user are echoed by - ncurses_getch. - Returns &false; on success, &true; if any error occurred. - - - To disable echo mode use ncurses_noecho. - - - + + + ncurses_echo + Activate keyboard input echo + + + Description + + boolncurses_echo + + + &warn.experimental.func; + + ncurses_echo enables echo mode. + All characters typed by user are echoed by + ncurses_getch. + Returns &false; on success, &true; if any error occurred. + + + To disable echo mode use ncurses_noecho. + + + + - - - ncurses_echochar - Single character output including refresh - - - Description - - intncurses_echochar - intcharacter - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_echochar + Single character output including refresh + + + Description + + intncurses_echochar + intcharacter + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_end - Stop using ncurses, clean up the screen - - - Description - - intncurses_end - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_end + Stop using ncurses, clean up the screen + + + Description + + intncurses_end + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_erase - Erase terminal screen - - - Description - - boolncurses_erase - - - &warn.experimental.func; - - ncurses_erase fills the terminal screen with - blanks. Created blanks have the current background rendition, set - by ncurses_bkgd. - &return.success; - - - See also ncurses_bkgd, and - ncurses_clear - - - + + + ncurses_erase + Erase terminal screen + + + Description + + boolncurses_erase + + + &warn.experimental.func; + + ncurses_erase fills the terminal screen with + blanks. Created blanks have the current background rendition, set + by ncurses_bkgd. + &return.success; + + + See also ncurses_bkgd, and + ncurses_clear + + + + - - - ncurses_erasechar - Returns current erase character - - - Description - - stringncurses_erasechar - - - &warn.experimental.func; - - ncurses_erasechar returns the current erase - char character. - - - See also: ncurses_killchar - - - + + + ncurses_erasechar + Returns current erase character + + + Description + + stringncurses_erasechar + + + &warn.experimental.func; + + ncurses_erasechar returns the current erase + char character. + + + See also: ncurses_killchar + + + + - - - ncurses_filter - Set LINES for iniscr() and newterm() to 1 - - - Description - - voidncurses_filter - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_filter + Set LINES for iniscr() and newterm() to 1 + + + Description + + voidncurses_filter + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_flash - Flash terminal screen (visual bell) - - - Description - - boolncurses_flash - - - &warn.experimental.func; - - ncurses_flash flashes the screen, and if - its not possible, sends an audible alert (bell). - Returns &false; on success, otherwise &true;. - - - See also: ncurses_beep - - - + + + ncurses_flash + Flash terminal screen (visual bell) + + + Description + + boolncurses_flash + + + &warn.experimental.func; + + ncurses_flash flashes the screen, and if + its not possible, sends an audible alert (bell). + Returns &false; on success, otherwise &true;. + + + See also: ncurses_beep + + + + - - - ncurses_flushinp - Flush keyboard input buffer - - - Description - - boolncurses_flushinp - - - &warn.experimental.func; - - The ncurses_flushinp throws away any - typeahead that has been typed and has not yet been read by your - program. - Returns &false; on success, otherwise &true;. - - - + + + ncurses_flushinp + Flush keyboard input buffer + + + Description + + boolncurses_flushinp + + + &warn.experimental.func; + + The ncurses_flushinp throws away any + typeahead that has been typed and has not yet been read by your + program. + Returns &false; on success, otherwise &true;. + + + + - - - ncurses_getch - Read a character from keyboard - - - Description - - intncurses_getch - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_getch + Read a character from keyboard + + + Description + + intncurses_getch + + + &warn.experimental.func; + + &warn.undocumented.func; + + + - - - ncurses_getmaxyx - Returns the size of a window - - - Description - - voidncurses_getmaxyx - resourcewindow - inty - intx - - &warn.experimental.func; - - ncurses_getmaxyx puts the horizontal and - vertical size of the window window - into the given variables y and - x. Variables must be passed - as reference, so they are updated when the user changes terminal - size. - - - + + + + ncurses_getmaxyx + Returns the size of a window + + + Description + + voidncurses_getmaxyx + resourcewindow + inty + intx + + &warn.experimental.func; + + ncurses_getmaxyx puts the horizontal and + vertical size of the window window + into the given variables y and + x. Variables must be passed + as reference, so they are updated when the user changes terminal + size. + + + + @@ -8,10 +8,10 @@ Description - - boolncurses_getmouse - arraymevent - + + boolncurses_getmouse + arraymevent + &warn.experimental.func; ncurses_getmouse reads mouse event out of @@ -56,7 +56,7 @@ switch (ncurses_getch()){ ?> ]]> - + See also ncurses_ungetmouse diff --git a/reference/ncurses/functions/ncurses-getyx.xml b/reference/ncurses/functions/ncurses-getyx.xml index ff5544868a..e2b66e2215 100644 --- a/reference/ncurses/functions/ncurses-getyx.xml +++ b/reference/ncurses/functions/ncurses-getyx.xml @@ -1,26 +1,24 @@ - + - - - ncurses_getyx - - Returns the current cursor position for a window - - - - Description - - voidncurses_getyx - resourcewindow - inty - intx - - - &warn.undocumented.func; - - - + + + ncurses_getyx + Returns the current cursor position for a window + + + Description + + voidncurses_getyx + resourcewindow + inty + intx + + + &warn.undocumented.func; + + + + - - - ncurses_halfdelay - Put terminal into halfdelay mode - - - Description - - intncurses_halfdelay - inttenth - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_halfdelay + Put terminal into halfdelay mode + + + Description + + intncurses_halfdelay + inttenth + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_has_colors - Check if terminal has colors - - - Description - - boolncurses_has_colors - - - &warn.experimental.func; - - ncurses_has_colors returns &true; or &false; - depending on whether the terminal has color capacities. - - - See also: ncurses_can_change_color - - - + + + ncurses_has_colors + Check if terminal has colors + + + Description + + boolncurses_has_colors + + + &warn.experimental.func; + + ncurses_has_colors returns &true; or &false; + depending on whether the terminal has color capacities. + + + See also: ncurses_can_change_color + + + + - - - ncurses_has_ic - Check for insert- and delete-capabilities - - - Description - - boolncurses_has_ic - - - &warn.experimental.func; - - ncurses_has_ic checks terminals insert- and - delete capabilities. It returns &true; when terminal has - insert/delete-capabilities, otherwise &false;. - - - See also: ncurses_has_il - - - + + + ncurses_has_ic + Check for insert- and delete-capabilities + + + Description + + boolncurses_has_ic + + + &warn.experimental.func; + + ncurses_has_ic checks terminals insert- and + delete capabilities. It returns &true; when terminal has + insert/delete-capabilities, otherwise &false;. + + + See also: ncurses_has_il + + + + - - - ncurses_has_il - Check for line insert- and delete-capabilities - - - Description - - boolncurses_has_il - - - &warn.experimental.func; - - ncurses_has_il checks terminals insert- and - delete-line-capabilities. It returns &true; when terminal has - insert/delete-line capabilities, otherwise &false; - - - See also: ncurses_has_ic - - - + + + ncurses_has_il + Check for line insert- and delete-capabilities + + + Description + + boolncurses_has_il + + + &warn.experimental.func; + + ncurses_has_il checks terminals insert- and + delete-line-capabilities. It returns &true; when terminal has + insert/delete-line capabilities, otherwise &false; + + + See also: ncurses_has_ic + + + + - - - ncurses_has_key - Check for presence of a function key on terminal keyboard - - - Description - - intncurses_has_key - intkeycode - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_has_key + Check for presence of a function key on terminal keyboard + + + Description + + intncurses_has_key + intkeycode + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_hide_panel - - Remove panel from the stack, making it invisible - - - - Description - - intncurses_hide_panel - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_hide_panel + Remove panel from the stack, making it invisible + + + Description + + intncurses_hide_panel + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_hline - Draw a horizontal line at current position using an attributed character and max. n characters long - - - Description - - intncurses_hline - intcharattr - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_hline + Draw a horizontal line at current position using an attributed character and max. n characters long + + + Description + + intncurses_hline + intcharattr + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_inch - Get character and attribute at current position - - - Description - - stringncurses_inch - - - &warn.experimental.func; - - ncurses_inch returns the character from the - current position. - - - + + + ncurses_inch + Get character and attribute at current position + + + Description + + stringncurses_inch + + + &warn.experimental.func; + + ncurses_inch returns the character from the + current position. + + + + - - - ncurses_init_color - Set new RGB value for color - - - Description - - intncurses_init_color - intcolor - intr - intg - intb - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_init_color + Set new RGB value for color + + + Description + + intncurses_init_color + intcolor + intr + intg + intb + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_init_pair - Allocate a color pair - - - Description - - intncurses_init_pair - intpair - intfg - intbg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_init_pair + Allocate a color pair + + + Description + + intncurses_init_pair + intpair + intfg + intbg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_init - Initialize ncurses - - - Description - - voidncurses_init - - - &warn.experimental.func; - - ncurses_init initializes the ncurses - interface and must be used before any other ncurses function. - - - + + + ncurses_init + Initialize ncurses + + + Description + + voidncurses_init + + + &warn.experimental.func; + + ncurses_init initializes the ncurses + interface and must be used before any other ncurses function. + + + + - - - ncurses_insch - Insert character moving rest of line including character at current position - - - Description - - intncurses_insch - intcharacter - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_insch + Insert character moving rest of line including character at current position + + + Description + + intncurses_insch + intcharacter + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_insdelln - Insert lines before current line scrolling down (negative numbers delete and scroll up) - - - Description - - intncurses_insdelln - intcount - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_insdelln + Insert lines before current line scrolling down (negative numbers delete and scroll up) + + + Description + + intncurses_insdelln + intcount + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_insertln - Insert a line, move rest of screen down - - - Description - - boolncurses_insertln - - - &warn.experimental.func; - - ncurses_insertln inserts a new line above - the current line. The bottom line will be lost. - - - + + + ncurses_insertln + Insert a line, move rest of screen down + + + Description + + boolncurses_insertln + + + &warn.experimental.func; + + ncurses_insertln inserts a new line above + the current line. The bottom line will be lost. + + + + - - - ncurses_insstr - Insert string at current position, moving rest of line right - - - Description - - intncurses_insstr - stringtext - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_insstr + Insert string at current position, moving rest of line right + + + Description + + intncurses_insstr + stringtext + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_instr - Reads string from terminal screen - - - Description - - intncurses_instr - stringbuffer - - &warn.experimental.func; - - ncurses_instr returns the number of - characters read from the current character position until end of - line. - buffer contains the characters. Attributes - are stripped from the characters. - - - + + + ncurses_instr + Reads string from terminal screen + + + Description + + intncurses_instr + stringbuffer + + &warn.experimental.func; + + ncurses_instr returns the number of + characters read from the current character position until end of + line. + buffer contains the characters. Attributes + are stripped from the characters. + + + + - - - ncurses_isendwin - Ncurses is in endwin mode, normal screen output may be performed - - - Description - - boolncurses_isendwin - - - &warn.experimental.func; - - ncurses_isendwin returns &true;, if - ncurses_endwin has been called without any - subsequent calls to ncurses_wrefresh, - otherwise &false;. - - - See also - ncurses_endwin and - ncurses_wrefresh. - - - + + + ncurses_isendwin + Ncurses is in endwin mode, normal screen output may be performed + + + Description + + boolncurses_isendwin + + + &warn.experimental.func; + + ncurses_isendwin returns &true;, if + ncurses_endwin has been called without any + subsequent calls to ncurses_wrefresh, + otherwise &false;. + + + See also + ncurses_endwin and + ncurses_wrefresh. + + + + - - - ncurses_keyok - Enable or disable a keycode - - - Description - - intncurses_keyok - intkeycode - boolenable - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_keyok + Enable or disable a keycode + + + Description + + intncurses_keyok + intkeycode + boolenable + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_keypad - - Turns keypad on or off - - - - Description - - intncurses_keypad - resourcewindow - boolbf - - - &warn.undocumented.func; - - - + + + ncurses_keypad + Turns keypad on or off + + + Description + + intncurses_keypad + resourcewindow + boolbf + + + &warn.undocumented.func; + + + + - - - ncurses_killchar - Returns current line kill character - - - Description - - stringncurses_killchar - - - &warn.experimental.func; - - ncurses_killchar returns the current line - kill character. - - - See also: ncurses_erasechar - - - + + + ncurses_killchar + Returns current line kill character + + + Description + + stringncurses_killchar + + + &warn.experimental.func; + + ncurses_killchar returns the current line + kill character. + + + See also: ncurses_erasechar + + + + @@ -8,10 +8,10 @@ Description - - stringncurses_longname - - + + stringncurses_longname + + &warn.experimental.func; ncurses_longname returns a verbose diff --git a/reference/ncurses/functions/ncurses-meta.xml b/reference/ncurses/functions/ncurses-meta.xml index e47e2e2a14..9a1ef664c7 100644 --- a/reference/ncurses/functions/ncurses-meta.xml +++ b/reference/ncurses/functions/ncurses-meta.xml @@ -1,25 +1,23 @@ - + - - - ncurses_meta - - Enables/Disable 8-bit meta key information - - - - Description - - intncurses_meta - resourcewindow - bool8bit - - - &warn.undocumented.func; - - - + + + ncurses_meta + Enables/Disable 8-bit meta key information + + + Description + + intncurses_meta + resourcewindow + bool8bit + + + &warn.undocumented.func; + + + + - - - ncurses_mouse_trafo - - Transforms coordinates - - - - Description - - boolncurses_mouse_trafo - inty - intx - booltoscreen - - - &warn.undocumented.func; - - - + + + ncurses_mouse_trafo + Transforms coordinates + + + Description + + boolncurses_mouse_trafo + inty + intx + booltoscreen + + + &warn.undocumented.func; + + + + - - - ncurses_mouseinterval - Set timeout for mouse button clicks - - - Description - - intncurses_mouseinterval - intmilliseconds - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mouseinterval + Set timeout for mouse button clicks + + + Description + + intncurses_mouseinterval + intmilliseconds + + &warn.experimental.func; + + &warn.undocumented.func; + + + + @@ -8,17 +8,17 @@ Description - - intncurses_mousemask - intnewmask - intoldmask - + + intncurses_mousemask + intnewmask + intoldmask + &warn.experimental.func; Function ncurses_mousemask will set mouse events to be reported. By default no mouse events will be reported. The function ncurses_mousemask will return a - mask to indicated which of the in parameter + mask to indicated which of the in parameter newmask specified mouse events can be reported. On complete failure, it returns 0. In parameter oldmask, which is @@ -80,7 +80,7 @@ if ($mask & $newmask){ ?> ]]> - + See also ncurses_getmouse, diff --git a/reference/ncurses/functions/ncurses-move-panel.xml b/reference/ncurses/functions/ncurses-move-panel.xml index 20127db1de..cc9beee61c 100644 --- a/reference/ncurses/functions/ncurses-move-panel.xml +++ b/reference/ncurses/functions/ncurses-move-panel.xml @@ -1,26 +1,24 @@ - + - - - ncurses_move_panel - - Moves a panel so that its upper-left corner is at [startx, starty] - - - - Description - - intncurses_move_panel - resourcepanel - intstartx - intstarty - - - &warn.undocumented.func; - - - + + + ncurses_move_panel + Moves a panel so that its upper-left corner is at [startx, starty] + + + Description + + intncurses_move_panel + resourcepanel + intstartx + intstarty + + + &warn.undocumented.func; + + + + - - - ncurses_move - Move output position - - - Description - - intncurses_move - inty - intx - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_move + Move output position + + + Description + + intncurses_move + inty + intx + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvaddch - Move current position and add character - - - Description - - intncurses_mvaddch - inty - intx - intc - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvaddch + Move current position and add character + + + Description + + intncurses_mvaddch + inty + intx + intc + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvaddchnstr - Move position and add attributed string with specified length - - - Description - - intncurses_mvaddchnstr - inty - intx - strings - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvaddchnstr + Move position and add attributed string with specified length + + + Description + + intncurses_mvaddchnstr + inty + intx + strings + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvaddchstr - Move position and add attributed string - - - Description - - intncurses_mvaddchstr - inty - intx - strings - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvaddchstr + Move position and add attributed string + + + Description + + intncurses_mvaddchstr + inty + intx + strings + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvaddnstr - Move position and add string with specified length - - - Description - - intncurses_mvaddnstr - inty - intx - strings - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvaddnstr + Move position and add string with specified length + + + Description + + intncurses_mvaddnstr + inty + intx + strings + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvaddstr - Move position and add string - - - Description - - intncurses_mvaddstr - inty - intx - strings - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvaddstr + Move position and add string + + + Description + + intncurses_mvaddstr + inty + intx + strings + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvcur - Move cursor immediately - - - Description - - intncurses_mvcur - intold_y - intold_x - intnew_y - intnew_x - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvcur + Move cursor immediately + + + Description + + intncurses_mvcur + intold_y + intold_x + intnew_y + intnew_x + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvdelch - Move position and delete character, shift rest of line left - - - Description - - intncurses_mvdelch - inty - intx - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvdelch + Move position and delete character, shift rest of line left + + + Description + + intncurses_mvdelch + inty + intx + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvgetch - Move position and get character at new position - - - Description - - intncurses_mvgetch - inty - intx - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvgetch + Move position and get character at new position + + + Description + + intncurses_mvgetch + inty + intx + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvhline - Set new position and draw a horizontal line using an attributed character and max. n characters long - - - Description - - intncurses_mvhline - inty - intx - intattrchar - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvhline + Set new position and draw a horizontal line using an attributed character and max. n characters long + + + Description + + intncurses_mvhline + inty + intx + intattrchar + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvinch - Move position and get attributed character at new position - - - Description - - intncurses_mvinch - inty - intx - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvinch + Move position and get attributed character at new position + + + Description + + intncurses_mvinch + inty + intx + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvvline - Set new position and draw a vertical line using an attributed character and max. n characters long - - - Description - - intncurses_mvvline - inty - intx - intattrchar - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvvline + Set new position and draw a vertical line using an attributed character and max. n characters long + + + Description + + intncurses_mvvline + inty + intx + intattrchar + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_mvwaddstr - Add string at new position in window - - - Description - - intncurses_mvwaddstr - resourcewindow - inty - intx - stringtext - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_mvwaddstr + Add string at new position in window + + + Description + + intncurses_mvwaddstr + resourcewindow + inty + intx + stringtext + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_napms - Sleep - - - Description - - intncurses_napms - intmilliseconds - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_napms + Sleep + + + Description + + intncurses_napms + intmilliseconds + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_new_panel - - Create a new panel and associate it with window - - - - Description - - resourcencurses_new_panel - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_new_panel + Create a new panel and associate it with window + + + Description + + resourcencurses_new_panel + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_newpad - - Creates a new pad (window) - - - - Description - - resourcencurses_newpad - introws - intcols - - - &warn.undocumented.func; - - - + + + ncurses_newpad + Creates a new pad (window) + + + Description + + resourcencurses_newpad + introws + intcols + + + &warn.undocumented.func; + + + + - - - ncurses_newwin - Create a new window - - - Description - - resourcencurses_newwin - introws - intcols - inty - intx - - &warn.experimental.func; - - ncurses_newwin creates a new window - to draw elements in. Windows can be positioned using - x, y, - rows and cols. - When creating additional windows, - remember to use ncurses_getmaxyx to check for - available space, as terminal size is individual and may vary. - The return value is a resource ID used to differ between multiple - windows. - - - + + + ncurses_newwin + Create a new window + + + Description + + resourcencurses_newwin + introws + intcols + inty + intx + + &warn.experimental.func; + + ncurses_newwin creates a new window + to draw elements in. Windows can be positioned using + x, y, + rows and cols. + When creating additional windows, + remember to use ncurses_getmaxyx to check for + available space, as terminal size is individual and may vary. + The return value is a resource ID used to differ between multiple + windows. + + + + - - - ncurses_nl - Translate newline and carriage return / line feed - - - Description - - boolncurses_nl - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_nl + Translate newline and carriage return / line feed + + + Description + + boolncurses_nl + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_nocbreak - Switch terminal to cooked mode - - - Description - - boolncurses_nocbreak - - - &warn.experimental.func; - - ncurses_nocbreak routine returns terminal to - normal (cooked) mode. Initially the terminal may or may not in - cbreak mode as the mode is inherited. Therefore a program should - call ncurses_cbreak and - ncurses_nocbreak explicitly. - Returns &true; if any error occurred, otherwise &false;. - - - See also: ncurses_cbreak - - - + + + ncurses_nocbreak + Switch terminal to cooked mode + + + Description + + boolncurses_nocbreak + + + &warn.experimental.func; + + ncurses_nocbreak routine returns terminal to + normal (cooked) mode. Initially the terminal may or may not in + cbreak mode as the mode is inherited. Therefore a program should + call ncurses_cbreak and + ncurses_nocbreak explicitly. + Returns &true; if any error occurred, otherwise &false;. + + + See also: ncurses_cbreak + + + + - - - ncurses_noecho - Switch off keyboard input echo - - - Description - - boolncurses_noecho - - - &warn.experimental.func; - - ncurses_noecho prevents echoing of user - typed characters. - Returns &true; if any error occurred, otherwise &false;. - - - See also: ncurses_echo, - ncurses_getch - - - + + + ncurses_noecho + Switch off keyboard input echo + + + Description + + boolncurses_noecho + + + &warn.experimental.func; + + ncurses_noecho prevents echoing of user + typed characters. + Returns &true; if any error occurred, otherwise &false;. + + + See also: ncurses_echo, + ncurses_getch + + + + - - - ncurses_nonl - Do not translate newline and carriage return / line feed - - - Description - - boolncurses_nonl - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_nonl + Do not translate newline and carriage return / line feed + + + Description + + boolncurses_nonl + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_noqiflush - Do not flush on signal characters - - - Description - - voidncurses_noqiflush - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_noqiflush + Do not flush on signal characters + + + Description + + voidncurses_noqiflush + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_noraw - Switch terminal out of raw mode - - - Description - - boolncurses_noraw - - - &warn.experimental.func; - - ncurses_noraw switches the terminal out of raw - mode. Raw mode is similar to cbreak mode, in that characters - typed are immediately passed through to the user program. The - differences that are that in raw mode, the interrupt, quit, - suspend and flow control characters are all passed through - uninterpreted, instead of generating a signal. - Returns &true; if any error occurred, otherwise &false;. - - - See also: ncurses_raw, - ncurses_cbreak, - ncurses_nocbreak - - - + + + ncurses_noraw + Switch terminal out of raw mode + + + Description + + boolncurses_noraw + + + &warn.experimental.func; + + ncurses_noraw switches the terminal out of raw + mode. Raw mode is similar to cbreak mode, in that characters + typed are immediately passed through to the user program. The + differences that are that in raw mode, the interrupt, quit, + suspend and flow control characters are all passed through + uninterpreted, instead of generating a signal. + Returns &true; if any error occurred, otherwise &false;. + + + See also: ncurses_raw, + ncurses_cbreak, + ncurses_nocbreak + + + + - - - ncurses_pair_content - - Gets the RGB value for color - - - - Description - - intncurses_pair_content - intpair - intf - intb - - - &warn.undocumented.func; - - - + + + ncurses_pair_content + Gets the RGB value for color + + + Description + + intncurses_pair_content + intpair + intf + intb + + + &warn.undocumented.func; + + + + - - - ncurses_panel_above - - Returns the panel above panel - - - - Description - - resourcencurses_panel_above - resourcepanel - - - &warn.undocumented.func; - - - If panel is null, returns the bottom panel in the stack. - - - + + + ncurses_panel_above + Returns the panel above panel + + + Description + + resourcencurses_panel_above + resourcepanel + + + &warn.undocumented.func; + + + If panel is null, returns the bottom panel in the stack. + + + + - - - ncurses_panel_below - - Returns the panel below panel - - - - Description - - resourcencurses_panel_below - resourcepanel - - - &warn.undocumented.func; - - - If panel is null, returns the top panel in the stack. - - - + + + ncurses_panel_below + Returns the panel below panel + + + Description + + resourcencurses_panel_below + resourcepanel + + + &warn.undocumented.func; + + + If panel is null, returns the top panel in the stack. + + + + - - - ncurses_panel_window - - Returns the window associated with panel - - - - Description - - resourcencurses_panel_window - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_panel_window + Returns the window associated with panel + + + Description + + resourcencurses_panel_window + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_pnoutrefresh - - Copies a region from a pad into the virtual screen - - - - Description - - intncurses_pnoutrefresh - resourcepad - intpminrow - intpmincol - intsminrow - intsmincol - intsmaxrow - intsmaxcol - - - &warn.undocumented.func; - - - + + + ncurses_pnoutrefresh + Copies a region from a pad into the virtual screen + + + Description + + intncurses_pnoutrefresh + resourcepad + intpminrow + intpmincol + intsminrow + intsmincol + intsmaxrow + intsmaxcol + + + &warn.undocumented.func; + + + + - - - ncurses_prefresh - - Copies a region from a pad into the virtual screen - - - - Description - - intncurses_prefresh - resourcepad - intpminrow - intpmincol - intsminrow - intsmincol - intsmaxrow - intsmaxcol - - - &warn.undocumented.func; - - - + + + ncurses_prefresh + Copies a region from a pad into the virtual screen + + + Description + + intncurses_prefresh + resourcepad + intpminrow + intpmincol + intsminrow + intsmincol + intsmaxrow + intsmaxcol + + + &warn.undocumented.func; + + + + - - - ncurses_putp - Apply padding information to the string and output it - - - Description - - intncurses_putp - stringtext - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_putp + Apply padding information to the string and output it + + + Description + + intncurses_putp + stringtext + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_qiflush - Flush on signal characters - - - Description - - voidncurses_qiflush - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_qiflush + Flush on signal characters + + + Description + + voidncurses_qiflush + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_raw - Switch terminal into raw mode - - - Description - - boolncurses_raw - - - &warn.experimental.func; - - ncurses_raw places the terminal in raw - mode. Raw mode is similar to cbreak mode, in that characters - typed are immediately passed through to the user program. The - differences that are that in raw mode, the interrupt, quit, - suspend and flow control characters are all passed through - uninterpreted, instead of generating a signal. - Returns &true; if any error occurred, otherwise &false;. - - - See also: ncurses_noraw, - ncurses_cbreak, - ncurses_nocbreak - - - + + + ncurses_raw + Switch terminal into raw mode + + + Description + + boolncurses_raw + + + &warn.experimental.func; + + ncurses_raw places the terminal in raw + mode. Raw mode is similar to cbreak mode, in that characters + typed are immediately passed through to the user program. The + differences that are that in raw mode, the interrupt, quit, + suspend and flow control characters are all passed through + uninterpreted, instead of generating a signal. + Returns &true; if any error occurred, otherwise &false;. + + + See also: ncurses_noraw, + ncurses_cbreak, + ncurses_nocbreak + + + + - - - ncurses_refresh - Refresh screen - - - Description - - intncurses_refresh - intch - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_refresh + Refresh screen + + + Description + + intncurses_refresh + intch + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_replace_panel - - Replaces the window associated with panel - - - - Description - - intncurses_replace_panel - resourcepanel - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_replace_panel + Replaces the window associated with panel + + + Description + + intncurses_replace_panel + resourcepanel + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_reset_prog_mode - - Resets the prog mode saved by def_prog_mode - - - - Description - - intncurses_reset_prog_mode - - - - &warn.undocumented.func; - - - + + + ncurses_reset_prog_mode + Resets the prog mode saved by def_prog_mode + + + Description + + intncurses_reset_prog_mode + + + + &warn.undocumented.func; + + + + - - - ncurses_reset_shell_mode - - Resets the shell mode saved by def_shell_mode - - - - Description - - intncurses_reset_shell_mode - - - - &warn.undocumented.func; - - - + + + ncurses_reset_shell_mode + Resets the shell mode saved by def_shell_mode + + + Description + + intncurses_reset_shell_mode + + + + &warn.undocumented.func; + + + + - - - ncurses_resetty - Restores saved terminal state - - - Description - - boolncurses_resetty - - - &warn.experimental.func; - - Function ncurses_resetty restores the - terminal state, which was previously saved by calling - ncurses_savetty. - This function always returns &false;. - - - See also: ncurses_savetty - - - + + + ncurses_resetty + Restores saved terminal state + + + Description + + boolncurses_resetty + + + &warn.experimental.func; + + Function ncurses_resetty restores the + terminal state, which was previously saved by calling + ncurses_savetty. + This function always returns &false;. + + + See also: ncurses_savetty + + + + - - - ncurses_savetty - Saves terminal state - - - Description - - boolncurses_savetty - - - &warn.experimental.func; - - Function ncurses_savetty saves the current - terminal state. The saved terminal state can be restored with - function ncurses_resetty. - ncurses_savetty always returns &false;. - - - See also: ncurses_resetty - - - + + + ncurses_savetty + Saves terminal state + + + Description + + boolncurses_savetty + + + &warn.experimental.func; + + Function ncurses_savetty saves the current + terminal state. The saved terminal state can be restored with + function ncurses_resetty. + ncurses_savetty always returns &false;. + + + See also: ncurses_resetty + + + + - - - ncurses_scr_dump - Dump screen content to file - - - Description - - intncurses_scr_dump - stringfilename - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_scr_dump + Dump screen content to file + + + Description + + intncurses_scr_dump + stringfilename + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_scr_init - Initialize screen from file dump - - - Description - - intncurses_scr_init - stringfilename - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_scr_init + Initialize screen from file dump + + + Description + + intncurses_scr_init + stringfilename + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_scr_restore - Restore screen from file dump - - - Description - - intncurses_scr_restore - stringfilename - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_scr_restore + Restore screen from file dump + + + Description + + intncurses_scr_restore + stringfilename + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_scr_set - Inherit screen from file dump - - - Description - - intncurses_scr_set - stringfilename - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_scr_set + Inherit screen from file dump + + + Description + + intncurses_scr_set + stringfilename + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_scrl - Scroll window content up or down without changing current position - - - Description - - intncurses_scrl - intcount - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_scrl + Scroll window content up or down without changing current position + + + Description + + intncurses_scrl + intcount + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_show_panel - - Places an invisible panel on top of the stack, making it visible - - - - Description - - intncurses_show_panel - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_show_panel + Places an invisible panel on top of the stack, making it visible + + + Description + + intncurses_show_panel + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_slk_attr - Returns current soft label key attribute - - - Description - - boolncurses_slk_attr - - - &warn.experimental.func; - - ncurses_slk_attr returns the current soft - label key attribute. On error returns &true;, otherwise &false;. - - - + + + ncurses_slk_attr + Returns current soft label key attribute + + + Description + + boolncurses_slk_attr + + + &warn.experimental.func; + + ncurses_slk_attr returns the current soft + label key attribute. On error returns &true;, otherwise &false;. + + + + - - - ncurses_slk_attroff - Turn off the given attributes for soft function-key labels - - - Description - - intncurses_slk_attroff - intintarg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_slk_attroff + Turn off the given attributes for soft function-key labels + + + Description + + intncurses_slk_attroff + intintarg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_slk_attron - Turn on the given attributes for soft function-key labels - - - Description - - intncurses_slk_attron - intintarg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_slk_attron + Turn on the given attributes for soft function-key labels + + + Description + + intncurses_slk_attron + intintarg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_slk_attrset - Set given attributes for soft function-key labels - - - Description - - intncurses_slk_attrset - intintarg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_slk_attrset + Set given attributes for soft function-key labels + + + Description + + intncurses_slk_attrset + intintarg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_slk_clear - Clears soft labels from screen - - - Description - - boolncurses_slk_clear - - - &warn.experimental.func; - - The function ncurses_slk_clear clears soft - label keys from screen. Returns &true; on error, otherwise &false;. - - - + + + ncurses_slk_clear + Clears soft labels from screen + + + Description + + boolncurses_slk_clear + + + &warn.experimental.func; + + The function ncurses_slk_clear clears soft + label keys from screen. Returns &true; on error, otherwise &false;. + + + + - - - ncurses_slk_color - Sets color for soft label keys - - - Description - - intncurses_slk_color - intintarg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_slk_color + Sets color for soft label keys + + + Description + + intncurses_slk_color + intintarg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_slk_init - Initializes soft label key functions - - - Description - - boolncurses_slk_init - intformat - - &warn.experimental.func; - - Function ncurses_slk_init must be called - before ncurses_initscr or - ncurses_newterm is called. If - ncurses_initscr eventually uses a line from - stdscr to emulate the soft labels, then - format determines how the labels are - arranged of the screen. Setting format to - 0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4 - arrangement and 2 indicates the PC like 4-4-4 mode, but in - addition an index line will be created. - - - + + + ncurses_slk_init + Initializes soft label key functions + + + Description + + boolncurses_slk_init + intformat + + &warn.experimental.func; + + Function ncurses_slk_init must be called + before ncurses_initscr or + ncurses_newterm is called. If + ncurses_initscr eventually uses a line from + stdscr to emulate the soft labels, then + format determines how the labels are + arranged of the screen. Setting format to + 0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4 + arrangement and 2 indicates the PC like 4-4-4 mode, but in + addition an index line will be created. + + + + - - - ncurses_slk_noutrefresh - Copies soft label keys to virtual screen - - - Description - - boolncurses_slk_noutrefresh - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_slk_noutrefresh + Copies soft label keys to virtual screen + + + Description + + boolncurses_slk_noutrefresh + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_slk_refresh - Copies soft label keys to screen - - - Description - - boolncurses_slk_refresh - - - &warn.experimental.func; - - ncurses_slk_refresh copies soft label keys - from virtual screen to physical screen. Returns &true; on error, - otherwise &false;. - - - + + + ncurses_slk_refresh + Copies soft label keys to screen + + + Description + + boolncurses_slk_refresh + + + &warn.experimental.func; + + ncurses_slk_refresh copies soft label keys + from virtual screen to physical screen. Returns &true; on error, + otherwise &false;. + + + + - - - ncurses_slk_restore - Restores soft label keys - - - Description - - boolncurses_slk_restore - - - &warn.experimental.func; - - The function ncurses_slk_restore restores - the soft label keys after ncurses_slk_clear - has been performed. - - - + + + ncurses_slk_restore + Restores soft label keys + + + Description + + boolncurses_slk_restore + + + &warn.experimental.func; + + The function ncurses_slk_restore restores + the soft label keys after ncurses_slk_clear + has been performed. + + + + - - - ncurses_slk_set - - Sets function key labels - - - - Description - - boolncurses_slk_set - intlabelnr - stringlabel - intformat - - - &warn.undocumented.func; - - - + + + ncurses_slk_set + Sets function key labels + + + Description + + boolncurses_slk_set + intlabelnr + stringlabel + intformat + + + &warn.undocumented.func; + + + + - - - ncurses_slk_touch - Forces output when ncurses_slk_noutrefresh is performed - - - Description - - boolncurses_slk_touch - - - &warn.experimental.func; - - The ncurses_slk_touch function forces all the soft - labels to be output the next time a - ncurses_slk_noutrefresh is performed. - - - + + + ncurses_slk_touch + Forces output when ncurses_slk_noutrefresh is performed + + + Description + + boolncurses_slk_touch + + + &warn.experimental.func; + + The ncurses_slk_touch function forces all the soft + labels to be output the next time a + ncurses_slk_noutrefresh is performed. + + + + - - - ncurses_standend - Stop using 'standout' attribute - - - Description - - intncurses_standend - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_standend + Stop using 'standout' attribute + + + Description + + intncurses_standend + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_standout - Start using 'standout' attribute - - - Description - - intncurses_standout - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_standout + Start using 'standout' attribute + + + Description + + intncurses_standout + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_start_color - Start using colors - - - Description - - intncurses_start_color - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_start_color + Start using colors + + + Description + + intncurses_start_color + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_termattrs - Returns a logical OR of all attribute flags supported by terminal - - - Description - - boolncurses_termattrs - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_termattrs + Returns a logical OR of all attribute flags supported by terminal + + + Description + + boolncurses_termattrs + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + @@ -8,10 +8,10 @@ Description - - stringncurses_termname - - + + stringncurses_termname + + &warn.experimental.func; ncurses_termname returns terminals diff --git a/reference/ncurses/functions/ncurses-timeout.xml b/reference/ncurses/functions/ncurses-timeout.xml index 6d0d14f883..27ae3de7ad 100644 --- a/reference/ncurses/functions/ncurses-timeout.xml +++ b/reference/ncurses/functions/ncurses-timeout.xml @@ -1,23 +1,23 @@ - + - - - ncurses_timeout - Set timeout for special key sequences - - - Description - - voidncurses_timeout - intmillisec - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_timeout + Set timeout for special key sequences + + + Description + + voidncurses_timeout + intmillisec + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_top_panel - - Moves a visible panel to the top of the stack - - - - Description - - intncurses_top_panel - resourcepanel - - - &warn.undocumented.func; - - - + + + ncurses_top_panel + Moves a visible panel to the top of the stack + + + Description + + intncurses_top_panel + resourcepanel + + + &warn.undocumented.func; + + + + - - - ncurses_typeahead - Specify different filedescriptor for typeahead checking - - - Description - - intncurses_typeahead - intfd - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_typeahead + Specify different filedescriptor for typeahead checking + + + Description + + intncurses_typeahead + intfd + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_ungetch - Put a character back into the input stream - - - Description - - intncurses_ungetch - intkeycode - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_ungetch + Put a character back into the input stream + + + Description + + intncurses_ungetch + intkeycode + + &warn.experimental.func; + + &warn.undocumented.func; + + + + @@ -8,10 +8,10 @@ Description - - boolncurses_ungetmouse - arraymevent - + + boolncurses_ungetmouse + arraymevent + &warn.experimental.func; ncurses_getmouse pushes a KEY_MOUSE event @@ -19,7 +19,7 @@ state sata and screen-relative character cell coordinates, specified in mevent. - Event options will be specified in associative array + Event options will be specified in associative array mevent: "id" : Id to distinguish multiple diff --git a/reference/ncurses/functions/ncurses-update-panels.xml b/reference/ncurses/functions/ncurses-update-panels.xml index 0e4b09f371..d9428a823d 100644 --- a/reference/ncurses/functions/ncurses-update-panels.xml +++ b/reference/ncurses/functions/ncurses-update-panels.xml @@ -1,24 +1,22 @@ - + - - - ncurses_update_panels - - Refreshes the virtual screen to reflect the relations between panels in the stack - - - - Description - - voidncurses_update_panels - - - - &warn.undocumented.func; - - - + + + ncurses_update_panels + Refreshes the virtual screen to reflect the relations between panels in the stack + + + Description + + voidncurses_update_panels + + + + &warn.undocumented.func; + + + + - - - ncurses_use_default_colors - Assign terminal default colors to color id -1 - - - Description - - boolncurses_use_default_colors - - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_use_default_colors + Assign terminal default colors to color id -1 + + + Description + + boolncurses_use_default_colors + + + &warn.experimental.func; + + &warn.undocumented.func; + + + + @@ -8,10 +8,10 @@ Description - - voidncurses_use_env - boolflag - + + voidncurses_use_env + boolflag + &warn.experimental.func; &warn.undocumented.func; diff --git a/reference/ncurses/functions/ncurses-use-extended-names.xml b/reference/ncurses/functions/ncurses-use-extended-names.xml index dbe390c214..535b8d7f8c 100644 --- a/reference/ncurses/functions/ncurses-use-extended-names.xml +++ b/reference/ncurses/functions/ncurses-use-extended-names.xml @@ -1,23 +1,23 @@ - + - - - ncurses_use_extended_names - Control use of extended names in terminfo descriptions - - - Description - - intncurses_use_extended_names - boolflag - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_use_extended_names + Control use of extended names in terminfo descriptions + + + Description + + intncurses_use_extended_names + boolflag + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_vidattr - Display the string on the terminal in the video attribute mode - - - Description - - intncurses_vidattr - intintarg - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_vidattr + Display the string on the terminal in the video attribute mode + + + Description + + intncurses_vidattr + intintarg + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_vline - Draw a vertical line at current position using an attributed character and max. n characters long - - - Description - - intncurses_vline - intcharattr - intn - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_vline + Draw a vertical line at current position using an attributed character and max. n characters long + + + Description + + intncurses_vline + intcharattr + intn + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_waddch - - Adds character at current position in a window and advance cursor - - - - Description - - intncurses_waddch - resourcewindow - intch - - - &warn.undocumented.func; - - - + + + ncurses_waddch + Adds character at current position in a window and advance cursor + + + Description + + intncurses_waddch + resourcewindow + intch + + + &warn.undocumented.func; + + + + - - - ncurses_waddstr - - Outputs text at current postion in window - - - - Description - - intncurses_waddstr - resourcewindow - stringstr - intn - - - &warn.undocumented.func; - - - + + + ncurses_waddstr + Outputs text at current postion in window + + + Description + + intncurses_waddstr + resourcewindow + stringstr + intn + + + &warn.undocumented.func; + + + + - - - ncurses_wattroff - - Turns off attributes for a window - - - - Description - - intncurses_wattroff - resourcewindow - intattrs - - - &warn.undocumented.func; - - - + + + ncurses_wattroff + Turns off attributes for a window + + + Description + + intncurses_wattroff + resourcewindow + intattrs + + + &warn.undocumented.func; + + + + - - - ncurses_wattron - - Turns on attributes for a window - - - - Description - - intncurses_wattron - resourcewindow - intattrs - - - &warn.undocumented.func; - - - + + + ncurses_wattron + Turns on attributes for a window + + + Description + + intncurses_wattron + resourcewindow + intattrs + + + &warn.undocumented.func; + + + + - - - ncurses_wattrset - - Set the attributes for a window - - - - Description - - intncurses_wattrset - resourcewindow - intattrs - - - &warn.undocumented.func; - - - + + + ncurses_wattrset + Set the attributes for a window + + + Description + + intncurses_wattrset + resourcewindow + intattrs + + + &warn.undocumented.func; + + + + - - - ncurses_wborder - Draws a border around the window using attributed characters - - - Description - - intncurses_wborder - resourcewindow - intleft - intright - inttop - intbottom - inttl_corner - inttr_corner - intbl_corner - intbr_corner - - &warn.experimental.func; - - ncurses_wborder draws the specified lines and - corners around the passed window window. Each - parameter expects 0 to draw a line and 1 to skip it. The corners are - top left, top right, bottom left and bottom right. - - - Use ncurses_border for borders around the main - window. - - - See also ncurses_border. - - - + + + ncurses_wborder + Draws a border around the window using attributed characters + + + Description + + intncurses_wborder + resourcewindow + intleft + intright + inttop + intbottom + inttl_corner + inttr_corner + intbl_corner + intbr_corner + + &warn.experimental.func; + + ncurses_wborder draws the specified lines and + corners around the passed window window. Each + parameter expects 0 to draw a line and 1 to skip it. The corners are + top left, top right, bottom left and bottom right. + + + Use ncurses_border for borders around the main + window. + + + See also ncurses_border. + + + + - - - ncurses_wclear - - Clears window - - - - Description - - intncurses_wclear - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_wclear + Clears window + + + Description + + intncurses_wclear + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_wcolor_set - - Sets windows color pairings - - - - Description - - intncurses_wcolor_set - resourcewindow - intcolor_pair - - - &warn.undocumented.func; - - - + + + ncurses_wcolor_set + Sets windows color pairings + + + Description + + intncurses_wcolor_set + resourcewindow + intcolor_pair + + + &warn.undocumented.func; + + + + - - - ncurses_werase - - Erase window contents - - - - Description - - intncurses_werase - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_werase + Erase window contents + + + Description + + intncurses_werase + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_wgetch - - Reads a character from keyboard (window) - - - - Description - - intncurses_wgetch - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_wgetch + Reads a character from keyboard (window) + + + Description + + intncurses_wgetch + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_whline - - Draws a horizontal line in a window at current position using an attributed character and max. n characters long - - - - Description - - intncurses_whline - resourcewindow - intcharattr - intn - - - &warn.undocumented.func; - - - + + + ncurses_whline + Draws a horizontal line in a window at current position using an attributed character and max. n characters long + + + Description + + intncurses_whline + resourcewindow + intcharattr + intn + + + &warn.undocumented.func; + + + + - - - ncurses_wmouse_trafo - - Transforms window/stdscr coordinates - - - - Description - - boolncurses_wmouse_trafo - resourcewindow - inty - intx - booltoscreen - - - &warn.undocumented.func; - - - + + + ncurses_wmouse_trafo + Transforms window/stdscr coordinates + + + Description + + boolncurses_wmouse_trafo + resourcewindow + inty + intx + booltoscreen + + + &warn.undocumented.func; + + + + - - - ncurses_wmove - - Moves windows output position - - - - Description - - intncurses_wmove - resourcewindow - inty - intx - - - &warn.undocumented.func; - - - + + + ncurses_wmove + Moves windows output position + + + Description + + intncurses_wmove + resourcewindow + inty + intx + + + &warn.undocumented.func; + + + + - - - ncurses_wnoutrefresh - - Copies window to virtual screen - - - - Description - - intncurses_wnoutrefresh - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_wnoutrefresh + Copies window to virtual screen + + + Description + + intncurses_wnoutrefresh + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_wrefresh - Refresh window on terminal screen - - - Description - - intncurses_wrefresh - resourcewindow - - &warn.experimental.func; - - &warn.undocumented.func; - - - + + + ncurses_wrefresh + Refresh window on terminal screen + + + Description + + intncurses_wrefresh + resourcewindow + + &warn.experimental.func; + + &warn.undocumented.func; + + + + - - - ncurses_wstandend - - End standout mode for a window - - - - Description - - intncurses_wstandend - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_wstandend + End standout mode for a window + + + Description + + intncurses_wstandend + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_wstandout - - Enter standout mode for a window - - - - Description - - intncurses_wstandout - resourcewindow - - - &warn.undocumented.func; - - - + + + ncurses_wstandout + Enter standout mode for a window + + + Description + + intncurses_wstandout + resourcewindow + + + &warn.undocumented.func; + + + + - - - ncurses_wvline - - Draws a vertical line in a window at current position using an attributed character and max. n characters long - - - - Description - - intncurses_wvline - resourcewindow - intcharattr - intn - - - &warn.undocumented.func; - - - + + + ncurses_wvline + Draws a vertical line in a window at current position using an attributed character and max. n characters long + + + Description + + intncurses_wvline + resourcewindow + intcharattr + intn + + + &warn.undocumented.func; + + +