Index: phpdoc/en/functions/ncurses.xml
diff -u phpdoc/en/functions/ncurses.xml:1.4 phpdoc/en/functions/ncurses.xml:1.5
--- phpdoc/en/functions/ncurses.xml:1.4 Tue Dec 25 18:25:24 2001
+++ phpdoc/en/functions/ncurses.xml Sun Dec 30 13:58:08 2001
@@ -1,5 +1,5 @@
-
+
Ncurses terminal screen control functionsncurses functions
@@ -160,7 +160,7 @@
ncurses_def_prog_mode
-
+ Saves terminals (program) modeDescription
@@ -186,7 +186,7 @@
ncurses_def_shell_mode
-
+ Saves terminals (shell) modeDescription
@@ -738,7 +738,7 @@
ncurses_resetty
- Restore saved terminal state
+ Restores saved terminal state Description
@@ -750,7 +750,13 @@
&warn.experimental.func;
- undocumented
+ Function ncurses_resetty restores the
+ terminal state, which was previously saved by calling
+ ncurses_savetty.
+ This function always returns &false;.
+
+
+ See also: ncurses_savetty
@@ -758,7 +764,7 @@
ncurses_savetty
- Save terminal state
+ Saves terminal state Description
@@ -770,15 +776,51 @@
&warn.experimental.func;
- undocumented
+ 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_slk_init
+ Initializes soft label key functions
+
+
+ Description
+
+
+ bool ncurses_slk_init
+ int format
+
+
+ &warn.experimental.func;
+
+ Funtion 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_attr
-
+ Returns current soft label key attributeDescription
@@ -790,7 +832,8 @@
&warn.experimental.func;
- undocumented
+ ncurses_slk_attr returns the current soft
+ label key attribute. On error returns &true;, otherwise &false;.
@@ -798,7 +841,7 @@
ncurses_slk_clear
-
+ Clears soft labels from screenDescription
@@ -810,7 +853,8 @@
&warn.experimental.func;
- undocumented
+ The function ncurses_slk_clear clears soft
+ label keys from screen. Returns &true; on error, otherwise &false;.
@@ -818,7 +862,7 @@
ncurses_slk_noutrefresh
-
+ Copies soft label keys to virtual screenDescription
@@ -838,7 +882,7 @@
ncurses_slk_refresh
-
+ Copies soft label keys to screenDescription
@@ -850,7 +894,9 @@
&warn.experimental.func;
- undocumented
+ ncurses_slk_refresh copies soft label keys
+ from virtual screen to physical screen. Returns &true; on error,
+ otherwise &false;.
@@ -858,7 +904,7 @@
ncurses_slk_restore
-
+ Restores soft label keysDescription
@@ -870,7 +916,9 @@
&warn.experimental.func;
- undocumented
+ The function ncurses_slk_restore restores
+ the soft label keys after ncurses_slk_clear
+ has been performed.
@@ -878,7 +926,7 @@
ncurses_slk_touch
-
+ Fources output when ncurses_slk_noutrefresh is performedDescription
@@ -890,7 +938,9 @@
&warn.experimental.func;
- undocumented
+ The ncurses_slk_touch function forces all the soft
+ labels to be output the next time a
+ ncurses_slk_noutrefresh is performed.
@@ -2233,26 +2283,6 @@
-
-
- ncurses_slk_init
-
-
-
- Description
-
-
- int ncurses_slk_init
- int intarg
-
-
- &warn.experimental.func;
-
- undocumented
-
-
-
-
ncurses_standend
@@ -2490,6 +2520,261 @@
&warn.experimental.func;
undocumented
+
+
+
+
+
+
+ ncurses_termname
+ Returns terminals (short)-name
+
+
+ Description
+
+
+ string ncurses_termname
+
+
+
+ &warn.experimental.func;
+
+ ncurses_termname returns terminals
+ shortname. The shortname is truncated to 14 characters.
+ On error ncurses_termname returns NULL.
+
+
+ See also: ncurses_longname
+
+
+
+
+
+
+ ncurses_longname
+ Returns terminals description
+
+
+ Description
+
+
+ string ncurses_longname
+
+
+
+ &warn.experimental.func;
+
+ ncurses_longname returns a verbose
+ description of the terminal. The descritpion is truncated to 128
+ characters.
+ On Error ncurses_longname returns NULL.
+
+
+ See also: ncurses_termname
+
+
+
+
+
+
+ ncurses_mousemask
+ Sets mouse options
+
+
+ Description
+
+
+ int ncurses_mousemask
+ int newmask,
+ int oldmask
+
+
+
+ &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
+ newmask
+ specified mouse events can be reported. On complete failure, it
+ returns 0. In parameter oldmask, which is
+ passed by reference ncurses_mousemask
+ returns the previous value of mouse event mask.
+
+ Mouse events are represented bei NCURSES_KEY_MOUSE in the
+ ncurses_wgetch input stream. To read the
+ event data and pop the event of of queue, call
+ ncurses_getmouse.
+
+
+ As a side effect, setting a zero mousemask in
+ newmask turns off the mouse
+ pointer. Setting a non zero value turns mouse pointer on.
+
+
+ mouse mask options can be set with the following predefined
+ constants:
+
+ NCURSES_BUTTON1_PRESSED
+ NCURSES_BUTTON1_RELEASED
+ NCURSES_BUTTON1_CLICKED
+ NCURSES_BUTTON1_DOUBLE_CLICKED
+ NCURSES_BUTTON1_TRIPLE_CLICKED
+ NCURSES_BUTTON2_PRESSED
+ NCURSES_BUTTON2_RELEASED
+ NCURSES_BUTTON2_CLICKED
+ NCURSES_BUTTON2_DOUBLE_CLICKED
+ NCURSES_BUTTON2_TRIPLE_CLICKED
+ NCURSES_BUTTON3_PRESSED
+ NCURSES_BUTTON3_RELEASED
+ NCURSES_BUTTON3_CLICKED
+ NCURSES_BUTTON3_DOUBLE_CLICKED
+ NCURSES_BUTTON3_TRIPLE_CLICKED
+ NCURSES_BUTTON4_PRESSED
+ NCURSES_BUTTON4_RELEASED
+ NCURSES_BUTTON4_CLICKED
+ NCURSES_BUTTON4_DOUBLE_CLICKED
+ NCURSES_BUTTON4_TRIPLE_CLICKED
+ NCURSES_BUTTON_SHIFT>
+ NCURSES_BUTTON_CTRL
+ NCURSES_BUTTON_ALT
+ NCURSES_ALL_MOUSE_EVENTS
+ NCURSES_REPORT_MOUSE_POSITION
+
+
+
+ See also: ncurses_getmouse,
+ ncurses_ungetmouse
+ ncurese_getch
+
+
+
+ ncurses_mousemask example
+
+
+
+
+
+
+
+
+
+
+ ncurses_getmouse
+ Reads mouse event
+
+
+ Description
+
+
+ bool ncurses_getmouse
+ array mevent
+
+
+ &warn.experimental.func;
+
+ ncurses_getmouse reads mouse event a pop
+ event out of queue. Function
+ ncurses_getmouse will return ;&false; if a
+ mouse event is actually visible in the given window, otherwise it
+ will return &true;.
+ Event options will be delivered in parameter
+ mevent, which has to be an array, passed
+ by reference (see example below).
+ On success an associative array with following keys will be
+ delivered:
+
+ "id" : Id to distinguish multiple
+ devices
+ "x" : screen relative x-position in character
+ cells
+ "y" : screen relative y-position in character
+ cells
+ "z" : currently not supported
+ "mmask" : Mouse action
+
+
+
+ ncurses_getmouse returns &false; on
+ success, otherwise &true;.
+
+
+
+ ncurses_getmouse example
+
+
+
+
+
+
+ See also: ncurses_ungetmouse
+
+
+
+
+
+
+ ncurses_ungetmouse
+ Pushes mouse event to queue
+
+
+ Description
+
+
+ bool ncurses_ungetmouse
+ array mevent
+
+
+ &warn.experimental.func;
+
+ ncurses_getmouse pushes a KEY_MOUSE event
+ onto the unput queue and associates with this event the given
+ state sata and screen-relative character cell coordinates,
+ specified in mevent.
+
+ Event options will be specified in associative array
+ mevent:
+
+ "id" : Id to distinguish multiple
+ devices
+ "x" : screen relative x-position in character
+ cells
+ "y" : screen relative y-position in character
+ cells
+ "z" : currently not supported
+ "mmask" : Mouse action
+
+
+
+ ncurses_ungetmouse returns &false; on
+ success, otherwise &true;.
+
+
+ See also: ncurses_getmouse