X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=d1bfe98c62ea12b61bd36d780393beca2d358743;hp=522c1a7c4735dc6a0bf717830050702d24d34fb5;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;ds=sidebyside
diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html
index 522c1a7c..d1bfe98c 100644
--- a/doc/html/man/curs_mouse.3x.html
+++ b/doc/html/man/curs_mouse.3x.html
@@ -2,7 +2,7 @@
@@ -48,9 +48,9 @@
NAME
- getmouse, ungetmouse, mousemask, wenclose, mouse_trafo,
- wmouse_trafo, mouseinterval - mouse interface through
- curses
+ has_mouse, getmouse, ungetmouse, mousemask, wenclose,
+ mouse_trafo, wmouse_trafo, mouseinterval - mouse interface
+ through curses
@@ -66,6 +66,7 @@
mmask_t bstate; /* button state bits */
}
MEVENT;
+ bool has_mouse(void);
int getmouse(MEVENT *event);
int ungetmouse(MEVENT *event);
mmask_t mousemask(mmask_t newmask, mmask_t *oldmask);
@@ -97,7 +98,6 @@
Here are the mouse event type masks which may be defined:
-
Name Description
---------------------------------------------------------------------
BUTTON1_PRESSED mouse button 1 down
@@ -148,7 +148,9 @@
as y and x in the event structure coordinates will be
screen-relative character-cell coordinates. The returned
state mask will have exactly one bit set to indicate the
- event type.
+ event type. The corresponding data in the queue is marked
+ invalid. A subsequent call to getmouse will retrieve the
+ next older item from the queue.
The ungetmouse function behaves analogously to ungetch.
It pushes a KEY_MOUSE event onto the input queue, and as-
@@ -162,36 +164,42 @@
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.
+ The has_mouse function returns TRUE if the mouse driver
+ has been successfully initialized.
+
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-
@@ -205,7 +213,9 @@
getmouse
returns an error. If no mouse driver was ini-
- tialized, or if the mask parameter is zero,
+ tialized, or if the mask parameter is zero, It
+ also returns an error if no more events remain
+ in the queue.
ungetmouse
returns an error if the FIFO is full.
@@ -247,11 +257,11 @@
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.
+ 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-
+ 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
@@ -268,15 +278,17 @@
BUGS
Mouse events under xterm will not in fact be ignored dur-
- ing cooked mode, if they have been enabled by wmousemask.
+ 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).
+ 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
@@ -288,7 +300,7 @@
SEE ALSO
- curses(3x).
+ curses(3x), curs_kernel(3x), curs_slk(3x).