diff options
Diffstat (limited to 'doc/html/man/curs_mouse.3x.html')
| -rw-r--r-- | doc/html/man/curs_mouse.3x.html | 427 |
1 files changed, 229 insertions, 198 deletions
diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html index b62defdfbe14..cdb42f278832 100644 --- a/doc/html/man/curs_mouse.3x.html +++ b/doc/html/man/curs_mouse.3x.html @@ -1,7 +1,7 @@ -<!-- +<!-- * t **************************************************************************** - * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 2018-2023,2024 Thomas E. Dickey * * Copyright 1998-2015,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,28 +28,28 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_mouse.3x,v 1.53 2020/10/17 23:25:08 tom Exp @ + * @Id: curs_mouse.3x,v 1.98 2024/04/20 19:02:07 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> -<TITLE>curs_mouse 3x</TITLE> +<TITLE>curs_mouse 3x 2024-04-20 ncurses 6.5 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </HEAD> <BODY> -<H1 class="no-header">curs_mouse 3x</H1> +<H1 class="no-header">curs_mouse 3x 2024-04-20 ncurses 6.5 Library calls</H1> <PRE> -<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> +<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> - <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>, <STRONG>mouse_trafo</STRONG>, - <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface through curses + <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>, <STRONG>mouse_trafo</STRONG>, + <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - get mouse events in <EM>curses</EM> </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> @@ -65,11 +65,11 @@ <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG> + <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <EM>newmask</EM><STRONG>,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*</STRONG><EM>oldmask</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG> <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG> - <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <EM>newmask</EM><STRONG>,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*</STRONG><EM>oldmask</EM><STRONG>);</STRONG> - <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG> <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG> @@ -85,61 +85,76 @@ <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> input stream. +</PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE> + The <STRONG>has_mouse</STRONG> function returns <STRONG>TRUE</STRONG> if the mouse driver has been + successfully initialized, and <STRONG>FALSE</STRONG> 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 <STRONG>getstr</STRONG> that expects a linefeed for input-loop + termination. + + </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE> - To make mouse events visible, use the <STRONG>mousemask</STRONG> function. This will - set the mouse events to be reported. By default, no mouse events are - reported. The function will return a mask to indicate which of the - specified mouse events can be reported; on complete failure it returns - 0. If oldmask is non-NULL, this function fills the indicated location - with the previous value of the given window's mouse event mask. - - As a side effect, setting a zero mousemask may turn off the mouse + To make mouse events visible, use the <STRONG>mousemask</STRONG> function. This sets + the mouse events to be reported. By default, no mouse events are + reported. + + <STRONG>o</STRONG> The function returns an updated copy of <EM>newmask</EM> to indicate which + of the specified mouse events can be reported. + + If the screen has not been initialized, or if the terminal does not + support mouse-events, this function returns 0. + + <STRONG>o</STRONG> If <EM>oldmask</EM> is non-<STRONG>NULL</STRONG>, this function fills the indicated location + with the previous value of the current screen's mouse event mask. + + As a side effect, setting a zero mouse mask may turn off the mouse pointer; setting a nonzero mask may turn it on. Whether this happens is device-dependent. -</PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE> +</PRE><H3><a name="h3-Mouse-Events">Mouse Events</a></H3><PRE> Here are the mouse event type masks which may be defined: - <EM>Name</EM> <EM>Description</EM> - --------------------------------------------------------------------- - 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 - --------------------------------------------------------------------- - BUTTON2_PRESSED mouse button 2 down - BUTTON2_RELEASED mouse button 2 up - BUTTON2_CLICKED mouse button 2 clicked - - 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 - BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked - --------------------------------------------------------------------- - BUTTON4_PRESSED mouse button 4 down - BUTTON4_RELEASED mouse button 4 up - BUTTON4_CLICKED mouse button 4 clicked - BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked - BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked - --------------------------------------------------------------------- - BUTTON5_PRESSED mouse button 5 down - BUTTON5_RELEASED mouse button 5 up - BUTTON5_CLICKED mouse button 5 clicked - BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked - BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked - --------------------------------------------------------------------- - BUTTON_SHIFT shift was down during button state change - BUTTON_CTRL control was down during button state change - BUTTON_ALT alt was down during button state change - ALL_MOUSE_EVENTS report all button state changes - REPORT_MOUSE_POSITION report mouse movement - --------------------------------------------------------------------- + <STRONG>Name</STRONG> <STRONG>Description</STRONG> + ------------------------------------------------------------------------ + <STRONG>BUTTON1_PRESSED</STRONG> mouse button 1 down + <STRONG>BUTTON1_RELEASED</STRONG> mouse button 1 up + <STRONG>BUTTON1_CLICKED</STRONG> mouse button 1 clicked + <STRONG>BUTTON1_DOUBLE_CLICKED</STRONG> mouse button 1 double clicked + <STRONG>BUTTON1_TRIPLE_CLICKED</STRONG> mouse button 1 triple clicked + ------------------------------------------------------------------------ + <STRONG>BUTTON2_PRESSED</STRONG> mouse button 2 down + <STRONG>BUTTON2_RELEASED</STRONG> mouse button 2 up + <STRONG>BUTTON2_CLICKED</STRONG> mouse button 2 clicked + <STRONG>BUTTON2_DOUBLE_CLICKED</STRONG> mouse button 2 double clicked + <STRONG>BUTTON2_TRIPLE_CLICKED</STRONG> mouse button 2 triple clicked + ------------------------------------------------------------------------ + <STRONG>BUTTON3_PRESSED</STRONG> mouse button 3 down + <STRONG>BUTTON3_RELEASED</STRONG> mouse button 3 up + <STRONG>BUTTON3_CLICKED</STRONG> mouse button 3 clicked + <STRONG>BUTTON3_DOUBLE_CLICKED</STRONG> mouse button 3 double clicked + <STRONG>BUTTON3_TRIPLE_CLICKED</STRONG> mouse button 3 triple clicked + ------------------------------------------------------------------------ + <STRONG>BUTTON4_PRESSED</STRONG> mouse button 4 down + <STRONG>BUTTON4_RELEASED</STRONG> mouse button 4 up + <STRONG>BUTTON4_CLICKED</STRONG> mouse button 4 clicked + <STRONG>BUTTON4_DOUBLE_CLICKED</STRONG> mouse button 4 double clicked + <STRONG>BUTTON4_TRIPLE_CLICKED</STRONG> mouse button 4 triple clicked + ------------------------------------------------------------------------ + <STRONG>BUTTON5_PRESSED</STRONG> mouse button 5 down + <STRONG>BUTTON5_RELEASED</STRONG> mouse button 5 up + <STRONG>BUTTON5_CLICKED</STRONG> mouse button 5 clicked + <STRONG>BUTTON5_DOUBLE_CLICKED</STRONG> mouse button 5 double clicked + <STRONG>BUTTON5_TRIPLE_CLICKED</STRONG> mouse button 5 triple clicked + ------------------------------------------------------------------------ + <STRONG>BUTTON_SHIFT</STRONG> shift was down during button state change + <STRONG>BUTTON_CTRL</STRONG> control was down during button state change + <STRONG>BUTTON_ALT</STRONG> alt was down during button state change + <STRONG>ALL_MOUSE_EVENTS</STRONG> report all button state changes + <STRONG>REPORT_MOUSE_POSITION</STRONG> report mouse movement + ------------------------------------------------------------------------ </PRE><H3><a name="h3-getmouse">getmouse</a></H3><PRE> @@ -149,11 +164,11 @@ event off the queue, call <STRONG>getmouse</STRONG>. This function will return <STRONG>OK</STRONG> if a mouse event is actually visible in the given window, <STRONG>ERR</STRONG> otherwise. When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the data deposited as y and x in the event - structure coordinates will be screen-relative character-cell coordi- - nates. The returned state mask will have exactly one bit set to indi- - cate the event type. The corresponding data in the queue is marked in- - valid. A subsequent call to <STRONG>getmouse</STRONG> will retrieve the next older item - from the queue. + structure coordinates will be screen-relative character-cell + coordinates. The returned state mask will have exactly one bit set to + indicate the event type. The corresponding data in the queue is marked + invalid. A subsequent call to <STRONG>getmouse</STRONG> will retrieve the next older + item from the queue. </PRE><H3><a name="h3-ungetmouse">ungetmouse</a></H3><PRE> @@ -168,73 +183,83 @@ <STRONG>TRUE</STRONG> if it is and <STRONG>FALSE</STRONG> otherwise. It is useful for determining what subset of the screen windows enclose the location of a mouse event. + If the parameter is a pad, <STRONG>wenclose</STRONG> uses the most recent screen + coordinates used for this pad in <STRONG><A HREF="curs_pad.3x.html">prefresh(3x)</A></STRONG> or <STRONG><A HREF="curs_pad.3x.html">pnoutrefresh(3x)</A></STRONG>. + </PRE><H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE> - The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coordinates from - stdscr-relative coordinates to coordinates relative to the given window - or vice versa. The resulting stdscr-relative coordinates are not al- - ways identical to window-relative coordinates due to the mechanism to - reserve lines on top or bottom of the screen for other purposes (see - the <STRONG>ripoffline</STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example). - - <STRONG>o</STRONG> If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must refer- - ence the coordinates of a location inside the window <STRONG>win</STRONG>. They are - converted to window-relative coordinates and returned through the - pointers. If the conversion was successful, the function returns - <STRONG>TRUE</STRONG>. - - <STRONG>o</STRONG> If one of the parameters was NULL or the location is not inside the + The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coordinates from + <STRONG>stdscr</STRONG>-relative coordinates to coordinates relative to the given window + or vice versa. The resulting <STRONG>stdscr</STRONG>-relative coordinates are not + always identical to screen coordinates due to the mechanism to reserve + lines on top or bottom of the screen for other purposes (see the + <STRONG><A HREF="curs_kernel.3x.html">ripoffline(3x)</A></STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example). + + <STRONG>o</STRONG> If the parameter <EM>to</EM><STRONG>_</STRONG><EM>screen</EM> is <STRONG>TRUE</STRONG>, the pointers <EM>pY,</EM> <EM>pX</EM> must + reference the coordinates of a location inside the window <EM>win</EM>. + They are converted to <STRONG>stdscr</STRONG>-relative coordinates and returned + through the pointers. If the conversion was successful, the + function returns <STRONG>TRUE</STRONG>. + + If one of the parameters was <STRONG>NULL</STRONG> or the location is not inside the window, <STRONG>FALSE</STRONG> is returned. - <STRONG>o</STRONG> If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference window- - relative coordinates. They are converted to stdscr-relative coor- - dinates if the window <STRONG>win</STRONG> encloses this point. In this case the - function returns <STRONG>TRUE</STRONG>. + <STRONG>o</STRONG> If <EM>to</EM><STRONG>_</STRONG><EM>screen</EM> is <STRONG>FALSE</STRONG>, the pointers <EM>pY,</EM> <EM>pX</EM> must reference + <STRONG>stdscr</STRONG>-relative coordinates. They are converted to window-relative + coordinates if the window <EM>win</EM> encloses this point. In this case + the function returns <STRONG>TRUE</STRONG>. - <STRONG>o</STRONG> If one of the parameters is NULL or the point is not inside the - window, <STRONG>FALSE</STRONG> is returned. The referenced coordinates are only re- - placed by the converted coordinates if the transformation was suc- - cessful. + If one of the parameters is <STRONG>NULL</STRONG> or the point is not inside the + window, <STRONG>FALSE</STRONG> is returned. + + The referenced coordinates are only replaced by the converted + coordinates if the transformation was successful. </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE> The <STRONG>mouse_trafo</STRONG> function performs the same translation as <STRONG>wmouse_trafo</STRONG>, - using stdscr for <STRONG>win</STRONG>. + using <STRONG>stdscr</STRONG> for <EM>win</EM>. </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE> The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be - recognized as a click. Use <STRONG>mouseinterval(0)</STRONG> to disable click resolu- - tion. This function returns the previous interval value. Use <STRONG>mousein-</STRONG> - <STRONG>terval(-1)</STRONG> to obtain the interval without altering it. The default is - one sixth of a second. + resolved as a <EM>click</EM>. 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". + Calling <STRONG>mouseinterval(0)</STRONG> disables click resolution. When <EM>ncurses</EM> + detects a mouse event, it awaits further input activity up to this + interval, and then checks for a subsequent mouse event which can be + combined with the first event. If the timeout expires without input + activity (which would happen with a zero interval), then no click + resolution will occur. -</PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE> - The <STRONG>has_mouse</STRONG> function returns <STRONG>TRUE</STRONG> if the mouse driver has been suc- - cessfully initialized. + This function returns the previous interval value. Use + <STRONG>mouseinterval(-1)</STRONG> to obtain the interval without altering it. - 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 <STRONG>getstr</STRONG> that expects a linefeed for input- - loop termination. + The mouse interval is set to one sixth of a second when the + corresponding screen is initialized, e.g., in <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> or + <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG>. </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon failure or <STRONG>OK</STRONG> upon - successful completion: + <STRONG>has_mouse</STRONG>, <STRONG>wenclose</STRONG>, <STRONG>mouse_trafo</STRONG>, and <STRONG>wmouse_trafo</STRONG> return <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> + as noted above. + + <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon success. - <STRONG>getmouse</STRONG> - returns an error. + <STRONG>getmouse</STRONG> fails if: - <STRONG>o</STRONG> If no mouse driver was initialized, or if the mask parameter is - zero, + <STRONG>o</STRONG> no mouse driver was initialized, - <STRONG>o</STRONG> It also returns an error if no more events remain in the queue. + <STRONG>o</STRONG> the mask of reportable events is zero, - <STRONG>ungetmouse</STRONG> - returns an error if the FIFO is full. + <STRONG>o</STRONG> a mouse event was detected that does not match the mask, + + <STRONG>o</STRONG> or if no more events remain in the queue. + + <STRONG>ungetmouse</STRONG> returns an error if the event queue is full. <STRONG>mousemask</STRONG> returns the mask of reportable events. @@ -242,130 +267,134 @@ was not initialized. In that case, it returns the maximum interval value (166). - <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> - depending on their test result. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed. + Additional fields may be added to the structure in the future. -</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> - These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not found in SVr4 - curses, 4.4BSD curses, or any other previous version of curses. + Under <EM>ncurses</EM>, these calls are implemented using either <EM>xterm</EM>'s built- + in mouse-tracking API or platform-specific drivers including - SVr4 curses had support for the mouse in a variant of <STRONG>xterm</STRONG>. It is - mentioned in a few places, but with no supporting documentation: + <STRONG>o</STRONG> Alessandro Rubini's gpm server - <STRONG>o</STRONG> the "libcurses" manual page lists functions for this feature which - are prototyped in <STRONG>curses.h</STRONG>: + <STRONG>o</STRONG> FreeBSD sysmouse - extern int mouse_set(long int); - extern int mouse_on(long int); - extern int mouse_off(long int); - extern int request_mouse_pos(void); - extern int map_button(unsigned long); - extern void wmouse_position(WINDOW *, int *, int *); - extern unsigned long getmouse(void), getbmap(void); + <STRONG>o</STRONG> OS/2 EMX - <STRONG>o</STRONG> the "terminfo" manual page lists capabilities for the feature + If you are using an unsupported configuration, mouse events will not be + visible to <EM>ncurses</EM> (and the <STRONG>mousemask</STRONG> function will always return <STRONG>0</STRONG>). - buttons btns BT Number of buttons on the mouse - get_mouse getm Gm Curses should get button events - key_mouse kmous Km 0631, Mouse event has occurred - mouse_info minfo Mi Mouse status information - req_mouse_pos reqmp RQ Request mouse position report + If the <EM>terminfo</EM> entry contains a <STRONG>XM</STRONG> string, this is used in the <EM>xterm</EM> + mouse driver to control the way the terminal is initialized for mouse + operation. The default, if <STRONG>XM</STRONG> is not found, corresponds to private + mode 1000 of <EM>xterm:</EM> - <STRONG>o</STRONG> the interface made assumptions (as does ncurses) about the escape - sequences sent to and received from the terminal. + \E[?1000%?%p1%{1}%=%th%el%; - For instance the SVr4 curses library used the <STRONG>get_mouse</STRONG> capability - to tell the terminal which mouse button events it should send, - passing the mouse-button bit-mask to the terminal. Also, it could - ask the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG> capa- - bility. + The mouse driver also recognizes a newer <EM>xterm</EM> private mode 1006, e.g., - Those features required a terminal which had been modified to work - with curses. They were not part of the X Consortium's xterm. + \E[?1006;1000%?%p1%{1}%=%th%el%; - 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 - use video terminals, making it unnecessary to be concerned about com- - patibility with the escape sequences. + The <EM>z</EM> 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 feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the preprocessor - can be used to test whether these features are present. If the inter- - face is changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be increment- - ed. These values for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when con- - figuring ncurses: + The <STRONG>ALL_MOUSE_EVENTS</STRONG> class does not include <STRONG>REPORT_MOUSE_POSITION</STRONG>. + They are distinct. For example, in <EM>xterm</EM>, wheel/scrolling mice send + position reports as a sequence of presses of buttons 4 or 5 without + matching button-releases. - 1 has definitions for reserved events. The mask uses 28 bits. - 2 adds definitions for button 5, removes the definitions for re- - served events. The mask uses 29 bits. +</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> + These functions were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not found in + SVr4 <EM>curses</EM>, 4.4BSD <EM>curses</EM>, or any other previous curses + implementation. (SVr4 <EM>curses</EM> did have a <EM>getmouse</EM> function, which took + no argument and returned a different type.) - The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed. Addition- - al fields may be added to the structure in the future. - Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented using either xterm's - built-in mouse-tracking API or platform-specific drivers including +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + Applications employing the <EM>ncurses</EM> mouse extension should condition its + use on the visibility of the <STRONG>NCURSES_MOUSE_VERSION</STRONG> preprocessor macro. + When the interface changes, the macro's value increments. Multiple + versions are available when <EM>ncurses</EM> is configured; see section + "ALTERNATE CONFIGURATIONS" of <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. The following values may be + specified. - <STRONG>o</STRONG> Alessandro Rubini's gpm server + 1 has definitions for reserved events. The mask uses 28 bits. - <STRONG>o</STRONG> FreeBSD sysmouse + 2 adds definitions for button 5, removes the definitions for + reserved events. The mask uses 29 bits. - <STRONG>o</STRONG> OS/2 EMX + SVr4 <EM>curses</EM> had support for the mouse in a variant of <STRONG>xterm(1)</STRONG>. It is + mentioned in a few places, with little supporting documentation. - If you are using an unsupported configuration, mouse events will not be - visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mousemask</STRONG> function will always return - <STRONG>0</STRONG>). + <STRONG>o</STRONG> Its "libcurses" manual page lists functions for this feature + prototyped in <EM>curses.h</EM>. - If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used in the xterm - mouse driver to control the way the terminal is initialized for mouse - operation. The default, if <STRONG>XM</STRONG> is not found, corresponds to private - mode 1000 of xterm: + extern int mouse_set(long int); + extern int mouse_on(long int); + extern int mouse_off(long int); + extern int request_mouse_pos(void); + extern int map_button(unsigned long); + extern void wmouse_position(WINDOW *, int *, int *); + extern unsigned long getmouse(void), getbmap(void); - \E[?1000%?%p1%{1}%=%th%el%; + <STRONG>o</STRONG> Its "terminfo" manual page lists capabilities for the feature. - The mouse driver also recognizes a newer xterm private mode 1006, e.g., + <STRONG>buttons</STRONG> <STRONG>btns</STRONG> <STRONG>BT</STRONG> Number of buttons on the mouse + <STRONG>get_mouse</STRONG> <STRONG>getm</STRONG> <STRONG>Gm</STRONG> Curses should get button events + <STRONG>key_mouse</STRONG> <STRONG>kmous</STRONG> <STRONG>Km</STRONG> 0631, Mouse event has occurred + <STRONG>mouse_info</STRONG> <STRONG>minfo</STRONG> <STRONG>Mi</STRONG> Mouse status information + <STRONG>req_mouse_pos</STRONG> <STRONG>reqmp</STRONG> <STRONG>RQ</STRONG> Request mouse position report - \E[?1006;1000%?%p1%{1}%=%th%el%; + <STRONG>o</STRONG> The interface made assumptions (as does <EM>ncurses</EM>) about the escape + sequences sent to and received from the terminal. - The <EM>z</EM> member in the event structure is not presently used. It is in- - tended for use with touch screens (which may be pressure-sensitive) or - with 3D-mice/trackballs/power gloves. + For instance, the SVr4 <EM>curses</EM> library used the <STRONG>get_mouse</STRONG> capability + to tell the terminal which mouse button events it should send, + passing the mouse-button bit mask to the terminal. Also, it could + ask the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG> + capability. - The <STRONG>ALL_MOUSE_EVENTS</STRONG> class does not include <STRONG>REPORT_MOUSE_POSITION</STRONG>. - 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. + Those features required a terminal program that had been modified + to work with SVr4 <EM>curses</EM>. They were not part of the X Consortium's + <EM>xterm</EM>. + + When developing the <EM>xterm</EM> mouse support for <EM>ncurses</EM> 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 <EM>PDCurses</EM> 2.3 using the SVr4 interface. <EM>PDCurses</EM>, however, does not + use video terminals, making it unnecessary to be concerned about + compatibility with the escape sequences. </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE> - Mouse events under xterm will not in fact be ignored during cooked - mode, if they have been enabled by <STRONG>mousemask</STRONG>. 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 interpreted as a variety of - function key. Your terminfo description should have <STRONG>kmous</STRONG> set to - "\E[M" (the beginning of the response from xterm for mouse clicks). - Other values for <STRONG>kmous</STRONG> are permitted, but under the same assumption, - 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, <STRONG>ncurses</STRONG> as- - sumes that if <STRONG>kmous</STRONG> is defined in the terminal description, or if the - terminal description's primary name or aliases contain the string - "xterm", then the terminal may send mouse events. The <STRONG>kmous</STRONG> capability - is checked first, allowing the use of newer xterm mouse protocols such - as xterm's private mode 1006. + Mouse events from <EM>xterm</EM> are <EM>not</EM> ignored in cooked mode if they have + been enabled by <STRONG>mousemask</STRONG>. Instead, the <EM>xterm</EM> mouse report sequence + appears in the string read. + + Mouse event reports from <EM>xterm</EM> are not detected correctly in a window + with keypad application mode disabled, since they are interpreted as a + variety of function key. Set the terminal's <EM>terminfo</EM> capability <STRONG>kmous</STRONG> + to "\E[M" (the beginning of the response from <EM>xterm</EM> for mouse clicks). + Other values of <STRONG>kmous</STRONG> are permitted under the same assumption, that is, + the report begins with that sequence. + + Because there are no standard response sequences that serve to identify + terminals supporting the <EM>xterm</EM> mouse protocol, <EM>ncurses</EM> assumes that if + <STRONG>kmous</STRONG> is defined in the terminal description, or if the terminal type's + primary name or aliases contain the string "xterm", then the terminal + may send mouse events. The <STRONG>kmous</STRONG> capability is checked first, allowing + use of newer <EM>xterm</EM> mouse protocols, such as its private mode 1006. </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>. + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>, + <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> - <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> +ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> </PRE> <div class="nav"> <ul> @@ -373,18 +402,20 @@ <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> <li><a href="#h2-DESCRIPTION">DESCRIPTION</a> <ul> +<li><a href="#h3-has_mouse">has_mouse</a></li> <li><a href="#h3-mousemask">mousemask</a></li> -<li><a href="#h3-Mouse-events">Mouse events</a></li> +<li><a href="#h3-Mouse-Events">Mouse Events</a></li> <li><a href="#h3-getmouse">getmouse</a></li> <li><a href="#h3-ungetmouse">ungetmouse</a></li> <li><a href="#h3-wenclose">wenclose</a></li> <li><a href="#h3-wmouse_trafo">wmouse_trafo</a></li> <li><a href="#h3-mouse_trafo">mouse_trafo</a></li> <li><a href="#h3-mouseinterval">mouseinterval</a></li> -<li><a href="#h3-has_mouse">has_mouse</a></li> </ul> </li> <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li> <li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-BUGS">BUGS</a></li> <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |