From e58a6fb09fe0d3310f742a907e06b51a8d90238a Mon Sep 17 00:00:00 2001 From: Georg Richter Date: Sat, 22 Dec 2001 18:02:35 +0000 Subject: [PATCH] Documentation for the following functions: ncurses_can_change_color ncurses_cbreak ncurses_clear ncurses_clrtobot ncurses_clrtoeol ncurses_def_rpog_mode ncurses_def_shell_mode ncurses_delch ncurses_deleteln ncurses_doupdate ncurses_echo ncurses_erase Status: 12 functions documented 102 functions still undocumented git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@65988 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/ncurses.xml | 118 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 104 insertions(+), 14 deletions(-) diff --git a/functions/ncurses.xml b/functions/ncurses.xml index d2e39087a2..84d26618ef 100644 --- a/functions/ncurses.xml +++ b/functions/ncurses.xml @@ -1,11 +1,23 @@ - + Ncurses terminal screen control functions ncurses functions + ncurses (new curses) is a free software emulation of curses in + System V Rel 4.0 (and above). It uses terminfo format, supports pads, colors, multiple + highlights, form characters and function key mapping. + + + To get these functions to work, you have to compile the CGI + version of PHP with . + That requires the ncurses library to be installed. Download the + latest version from &url.ncurses;, + compile and install it. @@ -25,7 +37,9 @@ &warn.experimental.func; - undocumented + 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. @@ -45,7 +59,17 @@ &warn.experimental.func; - undocumented + 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; if any error + occured, otherwise &false;. + + + See also: ncurses_nocbreak @@ -65,7 +89,16 @@ &warn.experimental.func; - undocumented + ncurses_clear clears the screen completely + without setting blanks. Returns &false; on success, otherwise &true;. + + + 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 @@ -85,7 +118,14 @@ &warn.experimental.func; - undocumented + ncurses_clrtobot erases all lines from cursor + to end of screen and creates blanks. Blanks created by + ncurses_clrtobot have the current background + rendition. Returns &true; if any error occured, otherwise &false;. + + + See also: ncurses_clear, + ncurses_clrtoeol @@ -105,8 +145,15 @@ &warn.experimental.func; - undocumented + ncurses_clrtoeol erases the current line from + cursor position to the end. Blanks created by + ncurses_clrtoeol have the current background + rendition. Returns &true; if any error occured, otherwise &false;. + + See also: ncurses_clear, + ncurses_clrtobot + @@ -125,7 +172,13 @@ &warn.experimental.func; - undocumented + 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 @@ -145,7 +198,13 @@ &warn.experimental.func; - undocumented + 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 @@ -165,7 +224,14 @@ &warn.experimental.func; - undocumented + 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 @@ -185,7 +251,15 @@ &warn.experimental.func; - undocumented + 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 @@ -205,7 +279,10 @@ &warn.experimental.func; - undocumented + 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. + Returns &false; on success, &true; if any error occured. @@ -225,7 +302,13 @@ &warn.experimental.func; - undocumented + ncurses_echo enables echo mode. + All characters typed by user are echoed by + ncurses_getch. + Returns &false; on success, &true; if any error occured. + + + To disable echo mode use ncurses_noecho. @@ -233,7 +316,7 @@ ncurses_erase - Erease terminal screen + Erase terminal screen Description @@ -245,7 +328,14 @@ &warn.experimental.func; - undocumented + ncurses_erase fills the terminal screen with + blanks. Created blanks have the current background rendition, set + by ncurses_bkgd. + Returns &false; on success, &true; if any error occured. + + + See also: ncurses_bkgd, + ncurses_clear