X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=7b62650d72c7a98ac148c51302aa2c3f4f8a6ace;hp=16771c76b1092a7ca639343796ecf3142517e64d;hb=HEAD;hpb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html index 16771c76..cdb42f27 100644 --- a/doc/html/man/curs_mouse.3x.html +++ b/doc/html/man/curs_mouse.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_mouse.3x,v 1.92 2024/02/24 19:54:30 tom Exp @ + * @Id: curs_mouse.3x,v 1.98 2024/04/20 19:02:07 tom Exp @ -->
-curs_mouse(3x) Library calls curs_mouse(3x) @@ -65,11 +65,11 @@ bool has_mouse(void); + mmask_t mousemask(mmask_t newmask, mmask_t *oldmask); + int getmouse(MEVENT *event); int ungetmouse(MEVENT *event); - mmask_t mousemask(mmask_t newmask, mmask_t *oldmask); - bool wenclose(const WINDOW *win, int y, int x); bool mouse_trafo(int* pY, int* pX, bool to_screen); @@ -85,6 +85,16 @@ wgetch(3x) input stream. +
+ The has_mouse function returns TRUE if the mouse driver has been + successfully initialized, and FALSE otherwise. + + Mouse events are ignored when input is in cooked mode, and cause an + error beep when cooked mode is being simulated in a window by a + function such as getstr that expects a linefeed for input-loop + termination. + +
To make mouse events visible, use the mousemask function. This sets the mouse events to be reported. By default, no mouse events are @@ -112,7 +122,6 @@ BUTTON1_PRESSED mouse button 1 down BUTTON1_RELEASED mouse button 1 up BUTTON1_CLICKED mouse button 1 clicked - BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked ------------------------------------------------------------------------ @@ -215,7 +224,7 @@
The mouseinterval function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be - resolved as a click. An application might interpret button press and + resolved as a click. An application might interpret button press and release events separated by more than the mouse interval as a "long press", or, with motion, as a "drag". @@ -234,16 +243,6 @@ setupterm(3x). -
- The has_mouse function returns TRUE if the mouse driver has been - successfully initialized, and FALSE otherwise. - - Mouse events are ignored when input is in cooked mode, and cause an - error beep when cooked mode is being simulated in a window by a - function such as getstr that expects a linefeed for input-loop - termination. - -
has_mouse, wenclose, mouse_trafo, and wmouse_trafo return TRUE or FALSE as noted above. @@ -273,7 +272,7 @@ The order of the MEVENT structure members is not guaranteed. Additional fields may be added to the structure in the future. - Under ncurses, these calls are implemented using either xterm's built- + Under ncurses, these calls are implemented using either xterm's built- in mouse-tracking API or platform-specific drivers including o Alessandro Rubini's gpm server @@ -301,7 +300,7 @@ or with 3D-mice/trackballs/power gloves. The ALL_MOUSE_EVENTS class does not include REPORT_MOUSE_POSITION. - They are distinct. For example, in xterm, wheel/scrolling mice send + They are distinct. For example, in xterm, wheel/scrolling mice send position reports as a sequence of presses of buttons 4 or 5 without matching button-releases. @@ -358,13 +357,13 @@ capability. Those features required a terminal program that had been modified - to work with SVr4 curses. They were not part of the X Consortium's - xterm. + to work with SVr4 curses. They were not part of the X Consortium's + xterm. When developing the xterm mouse support for ncurses in September 1995, Eric Raymond was uninterested in using the same interface due to its lack of documentation. Later, in 1998, Mark Hesseling provided support - in PDCurses 2.3 using the SVr4 interface. PDCurses, however, does not + in PDCurses 2.3 using the SVr4 interface. PDCurses, however, does not use video terminals, making it unnecessary to be concerned about compatibility with the escape sequences. @@ -395,7 +394,7 @@ -ncurses 6.4 2024-02-24 curs_mouse(3x) +ncurses 6.5 2024-04-20 curs_mouse(3x)