X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=230948267bab30c6ca6b91bc93ae1e1b5f03063e;hb=f36e772702d4b512a4395e2db96470803485b6df;hp=522c1a7c4735dc6a0bf717830050702d24d34fb5;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git
diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html
index 522c1a7c..23094826 100644
--- a/doc/html/man/curs_mouse.3x.html
+++ b/doc/html/man/curs_mouse.3x.html
@@ -2,7 +2,7 @@
@@ -162,45 +162,48 @@
screen windows enclose the location of a mouse event.
The wmouse_trafo function transforms a given pair of coor-
- dinates from stdscr-relative coordinates to screen-rela-
- tive coordinates or vice versa. Please remember, that
- stdscr-relative coordinates are not always identical to
- screen-relative coordinates due to the mechanism to re-
- serve lines on top or bottom of the screen for other pur-
- poses (ripoff() call, see also slk_... functions). If
- the parameter to_screen is TRUE, the pointers pY, pX must
- reference the coordinates of a location inside the window
- win. They are converted to screen-relative coordinates
- and returned through the pointers. If the conversion was
- successful, the function returns TRUE. If one of the pa-
- rameters was NULL or the location is not inside the win-
- dow, FALSE is returned. If to_screen is FALSE, the point-
- ers pY, pX must reference screen-relative coordinates.
- They are converted to stdscr-relative coordinates if the
- window win encloses this point. In this case the function
- returns TRUE. If one of the parameters is NULL or the
- point is not inside the window, FALSE is returned. Please
- notice, that the referenced coordinates are only replaced
- by the converted coordinates if the transformation was
- successful.
+ dinates from stdscr-relative coordinates to coordinates
+ relative to the given window or vice versa. Please remem-
+ ber, that stdscr-relative coordinates are not always iden-
+ tical to window-relative coordinates due to the mechanism
+ to reserve lines on top or bottom of the screen for other
+ purposes (see the ripoffline() and slk_init calls, for ex-
+ ample). If the parameter to_screen is TRUE, the pointers
+ pY, pX must reference the coordinates of a location inside
+ the window win. They are converted to window-relative co-
+ ordinates and returned through the pointers. If the con-
+ version was successful, the function returns TRUE. If one
+ of the parameters was NULL or the location is not inside
+ the window, FALSE is returned. If to_screen is FALSE, the
+ pointers pY, pX must reference window-relative coordi-
+ nates. They are converted to stdscr-relative coordinates
+ if the window win encloses this point. In this case the
+ function returns TRUE. If one of the parameters is NULL
+ or the point is not inside the window, FALSE is returned.
+ Please notice, that the referenced coordinates are only
+ replaced by the converted coordinates if the transforma-
+ tion was successful.
+
+ The mouse_trafo function performs the same translation as
+ wmouse_trafo, using stdscr for win.
The mouseinterval function sets the maximum time (in thou-
- sands of a second) that can elapse between press and re-
- lease events for them to be recognized as a click. Use
- mouseinterval(0) to disable click resolution. This func-
+ sands of a second) that can elapse between press and re-
+ lease events for them to be recognized as a click. Use
+ mouseinterval(0) to disable click resolution. This func-
tion returns the previous interval value. Use mouseinter-
- val(-1) to obtain the interval without altering it. The
+ val(-1) to obtain the interval without altering it. The
default is one sixth of a second.
- Note that mouse events will be ignored when input is in
+ Note that mouse events will be ignored when input is in
cooked mode, and will cause an error beep when cooked mode
- is being simulated in a window by a function such as get-
+ is being simulated in a window by a function such as get-
str that expects a linefeed for input-loop termination.
RETURN VALUE
- getmouse and ungetmouse return the integer ERR upon fail-
+ getmouse and ungetmouse return the integer ERR upon fail-
ure or OK upon successful completion.
getmouse
@@ -212,83 +215,85 @@
mousemask returns the mask of reportable events.
- mouseinterval returns the previous interval value, unless
- the terminal was not initialized. In that case, it re-
+ mouseinterval returns the previous interval value, unless
+ the terminal was not initialized. In that case, it re-
turns the maximum interval value (166).
- wenclose and wmouse_trafo are boolean functions returning
+ wenclose and wmouse_trafo are boolean functions returning
TRUE or FALSE depending on their test result.
PORTABILITY
- These calls were designed for ncurses(3x), and are not
+ These calls were designed for ncurses(3x), and are not
found in SVr4 curses, 4.4BSD curses, or any other previous
version of curses.
The feature macro NCURSES_MOUSE_VERSION is provided so the
- preprocessor can be used to test whether these features
- are present. If the interface is changed, the value of
- NCURSES_MOUSE_VERSION will be incremented. These values
- for NCURSES_MOUSE_VERSION may be specified when configur-
+ preprocessor can be used to test whether these features
+ are present. If the interface is changed, the value of
+ NCURSES_MOUSE_VERSION will be incremented. These values
+ for NCURSES_MOUSE_VERSION may be specified when configur-
ing ncurses:
- 1 has definitions for reserved events. The mask
+ 1 has definitions for reserved events. The mask
uses 28 bits.
2 adds definitions for button 5, removes the defi-
- nitions for reserved events. The mask uses 29
+ nitions for reserved events. The mask uses 29
bits.
- The order of the MEVENT structure members is not guaran-
- teed. Additional fields may be added to the structure in
+ The order of the MEVENT structure members is not guaran-
+ teed. Additional fields may be added to the structure in
the future.
- Under ncurses(3x), these calls are implemented using ei-
- ther xterm's built-in mouse-tracking API or platform-spe-
+ Under ncurses(3x), these calls are implemented using ei-
+ ther xterm's built-in mouse-tracking API or platform-spe-
cific drivers including
Alessandro Rubini's gpm server.
FreeBSD sysmouse
OS/2 EMX
- If you are using an unsupported configuration, mouse
- events will not be visible to ncurses(3x) (and the wmouse-
+ If you are using an unsupported configuration, mouse
+ events will not be visible to ncurses(3x) (and the mouse-
mask function will always return 0).
- If the terminfo entry contains a XM string, this is used
- in the xterm mouse driver to control the way the terminal
+ If the terminfo entry contains a XM string, this is used
+ in the xterm mouse driver to control the way the terminal
is initialized for mouse operation. The default, if XM is
not found, corresponds to private mode 1000 of xterm:
\E[?1000%?%p1%{1}%=%th%el%;
The z member in the event structure is not presently used.
- It is intended for use with touch screens (which may be
+ It is intended for use with touch screens (which may be
pressure-sensitive) or with 3D-mice/trackballs/power
gloves.
BUGS
- Mouse events under xterm will not in fact be ignored dur-
- ing cooked mode, if they have been enabled by wmousemask.
- Instead, the xterm mouse report sequence will appear in
+ Mouse events under xterm will not in fact be ignored dur-
+ ing cooked mode, if they have been enabled by mousemask.
+ Instead, the xterm mouse report sequence will appear in
the string read.
Mouse events under xterm will not be detected correctly in
- a window with its keypad bit off, since they are inter-
- preted as a variety of function key. Your terminfo de-
- scription must have kmous set to "\E[M" (the beginning of
- the response from xterm for mouse clicks).
-
- Because there are no standard terminal responses that
- would serve to identify terminals which support the xterm
- mouse protocol, ncurses assumes that if your $TERM envi-
- ronment variable contains "xterm", or kmous is defined in
+ a window with its keypad bit off, since they are inter-
+ preted as a variety of function key. Your terminfo de-
+ scription should have kmous set to "\E[M" (the beginning
+ of the response from xterm for mouse clicks). Other val-
+ ues for kmous are permitted, but under the same assump-
+ tion, i.e., it is the beginning of the response.
+
+ Because there are no standard terminal responses that
+ would serve to identify terminals which support the xterm
+ mouse protocol, ncurses assumes that if your $TERM envi-
+ ronment variable contains "xterm", or kmous is defined in
the terminal description, then the terminal may send mouse
events.
SEE ALSO
- curses(3x).
+ curses(3x), curs_kernel(3x), curs_slk(3x).