X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=47a98d9df8e7a8373c8578e8b90a79ce26a86288;hp=f8d2e9ca689df87745850bffa528a202e360e86e;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=e2d7d0028f4298dca2b0edaf2dc8ce30518d9218 diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html index f8d2e9ca..47a98d9d 100644 --- a/doc/html/man/curs_mouse.3x.html +++ b/doc/html/man/curs_mouse.3x.html @@ -1,8 +1,7 @@ - +
+ +- curs_mouse(3x) curs_mouse(3x)-
+NAME
has_mouse, getmouse, ungetmouse, mousemask, wenclose, mouse_trafo, wmouse_trafo, mouseinterval - mouse interface through curses-SYNOPSIS
+SYNOPSIS
#include <curses.h> typedef unsigned long mmask_t; - typedef struct - { - short id; /* ID to distinguish multiple devices */ + typedef struct { + short id; /* ID to distinguish multiple devices */ int x, y, z; /* event coordinates */ mmask_t bstate; /* button state bits */ - } - MEVENT; + } MEVENT; + bool has_mouse(void); int getmouse(MEVENT *event); int ungetmouse(MEVENT *event); @@ -78,7 +77,7 @@-DESCRIPTION
+DESCRIPTION
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. @@ -112,8 +111,8 @@ BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked --------------------------------------------------------------------- - BUTTON3_PRESSED mouse button 3 down + BUTTON3_RELEASED mouse button 3 up BUTTON3_CLICKED mouse button 3 clicked BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked @@ -138,7 +137,7 @@ REPORT_MOUSE_POSITION report mouse movement --------------------------------------------------------------------- - Once a class of mouse events have been made visible in a + 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 queued. To read the event data and pop the event off the @@ -159,7 +158,7 @@ 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- + a given window, returning TRUE if it is and FALSE other- wise. It is useful for determining what subset of the screen windows enclose the location of a mouse event. @@ -197,7 +196,7 @@ 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 + 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 @@ -207,7 +206,7 @@-RETURN VALUE
+RETURN VALUE
getmouse and ungetmouse return the integer ERR upon fail- ure or OK upon successful completion. @@ -231,7 +230,7 @@-PORTABILITY
+PORTABILITY
These calls were designed for ncurses(3x), and are not found in SVr4 curses, 4.4BSD curses, or any other previous version of curses. @@ -269,14 +268,21 @@ 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 pressure-sensitive) or with 3D-mice/trackballs/power gloves. + The ALL_MOUSE_EVENTS class does not include RE- + PORT_MOUSE_POSITION. They are distinct. For example, in + xterm, wheel/scrolling mice send position reports as a se- + quence of presses of buttons 4 or 5 without matching but- + ton-releases. +-BUGS
+BUGS
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 @@ -299,7 +305,7 @@-SEE ALSO
+SEE ALSO
curses(3x), curs_kernel(3x), curs_slk(3x), curs_vari- ables(3x). @@ -307,10 +313,16 @@ curs_mouse(3x)-
- -Man(1) output converted with -man2html - +