X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=383685d534c9f8ef7eabe13e24ba0879b2fff26b;hp=f4951c1c34e348e57e4cc1ffd8494fbd2aed78a2;hb=2a32bee362db64f5a06b2124976b928ac3faa578;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98
diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html
index f4951c1c..383685d5 100644
--- a/doc/html/man/curs_mouse.3x.html
+++ b/doc/html/man/curs_mouse.3x.html
@@ -46,15 +46,13 @@
-
-
+
has_mouse, getmouse, ungetmouse, mousemask, wenclose,
mouse_trafo, wmouse_trafo, mouseinterval - mouse interface
through curses
-
-
+
#include <curses.h>
typedef unsigned long mmask_t;
@@ -76,15 +74,13 @@
int mouseinterval(int erval);
-
-
+
These functions provide an interface to mouse events from
ncurses(3x). Mouse events are represented by KEY_MOUSE
pseudo-key values in the wgetch input stream.
-
-
+
To make mouse events visible, use the mousemask function.
This will set the mouse events to be reported. By de-
fault, no mouse events are reported. The function will
@@ -99,8 +95,7 @@
Whether this happens is device-dependent.
-
-
+
Here are the mouse event type masks which may be defined:
Name Description
@@ -145,8 +140,7 @@
---------------------------------------------------------------------
-
-
+
Once a class of mouse events has been made visible in a
window, calling the wgetch function on that window may re-
turn KEY_MOUSE as an indicator that a mouse event has been
@@ -162,16 +156,14 @@
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-
sociates with that event the given state data and screen-
relative character-cell coordinates.
-
-
+
The wenclose function tests whether a given pair of
screen-relative character-cell coordinates is enclosed by
a given window, returning TRUE if it is and FALSE other-
@@ -179,8 +171,7 @@
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 coordinates
relative to the given window or vice versa. The resulting
@@ -211,14 +202,12 @@
nates if the transformation 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
@@ -228,8 +217,7 @@
default is one sixth of a second.
-
-
+
The has_mouse function returns TRUE if the mouse driver
has been successfully initialized.
@@ -239,8 +227,7 @@
str that expects a linefeed for input-loop termination.
-
-
+
getmouse and ungetmouse return the integer ERR upon fail-
ure or OK upon successful completion:
@@ -266,8 +253,7 @@
TRUE or FALSE depending on their test result.
-
-
+
These calls were designed for ncurses(3x), and are not
found in SVr4 curses, 4.4BSD curses, or any other previous
version of curses.
@@ -322,8 +308,7 @@
ton-releases.
-
-
+
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
@@ -345,8 +330,7 @@
events.
-
-
+
curses(3x), curs_kernel(3x), curs_slk(3x), curs_vari-
ables(3x).