X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_mouse.3x.html;h=3376019bb8b2d691d7a844f6b6140dc5282183be;hp=2506e2b50267848a3a7c123e1e03de37da7b81f0;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html index 2506e2b5..3376019b 100644 --- a/doc/html/man/curs_mouse.3x.html +++ b/doc/html/man/curs_mouse.3x.html @@ -1,7 +1,8 @@ -
- +Here are the mouse event type masks which may be defined: - Name Description + Name Description --------------------------------------------------------------------- BUTTON1_PRESSED mouse button 1 down BUTTON1_RELEASED mouse button 1 up @@ -106,12 +112,12 @@ 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 @@ -171,8 +177,8 @@ reserve lines on top or bottom of the screen for other purposes (see the ripoffline and slk_init(3x) calls, for example). - o If the parameter to_screen is TRUE, the pointers pY, pX must refer- - ence the coordinates of a location inside the window win. They are + o If the parameter to_screen is TRUE, the pointers pY, pX must refer- + ence the coordinates of a location inside the window win. They are converted to window-relative coordinates and returned through the pointers. If the conversion was successful, the function returns TRUE. @@ -180,9 +186,9 @@ o If one of the parameters was NULL or the location is not inside the window, FALSE is returned. - o If to_screen is FALSE, the pointers pY, pX must reference window- + o If to_screen is FALSE, the pointers pY, pX must reference window- relative coordinates. They are converted to stdscr-relative coor- - dinates if the window win encloses this point. In this case the + dinates if the window win encloses this point. In this case the function returns TRUE. o If one of the parameters is NULL or the point is not inside the @@ -193,7 +199,7 @@
The mouse_trafo function performs the same translation as wmouse_trafo, - using stdscr for win. + using stdscr for win.
@@ -244,27 +250,27 @@ These calls were designed for ncurses(3x), and are not found in SVr4 curses, 4.4BSD curses, or any other previous version of curses. - SVr4 curses had support for the mouse in a variant of xterm. It is + SVr4 curses had support for the mouse in a variant of xterm(1). It is mentioned in a few places, but with no supporting documentation: - o the libcurses manual page lists functions for this feature which + o the "libcurses" manual page lists functions for this feature which are prototyped in curses.h: - 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); + 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); - o the terminfo manual page lists capabilities for the feature + o the "terminfo" manual page lists capabilities for the feature - 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 occured - mouse_info minfo Mi Mouse status information - req_mouse_pos reqmp RQ Request mouse position report + 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 o the interface made assumptions (as does ncurses) about the escape sequences sent to and received from the terminal. @@ -319,6 +325,10 @@ \E[?1000%?%p1%{1}%=%th%el%; + The mouse driver also recognizes a newer xterm private mode 1006, e.g., + + \E[?1006;1000%?%p1%{1}%=%th%el%; + The z 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. @@ -343,9 +353,11 @@ Because there are no standard terminal responses that would serve to identify terminals which support the xterm mouse protocol, ncurses as- - sumes that if your $TERM environment variable contains "xterm", or - kmous is defined in the terminal description, then the terminal may - send mouse events. + sumes that if kmous 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 kmous capability + is checked first, allowing the use of newer xterm mouse protocols such + as xterm's private mode 1006.