+ <B>o</B> the "libcurses" manual page lists functions for this feature which
+ are prototyped in <B>curses.h</B>:
+
+ 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);
+
+ <B>o</B> 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 occurred
+ mouse_info minfo Mi Mouse status information
+ req_mouse_pos reqmp RQ Request mouse position report
+
+ <B>o</B> the interface made assumptions (as does ncurses) about the escape
+ sequences sent to and received from the terminal.
+
+ For instance the SVr4 curses library used the <B>get_mouse</B> 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 <B>req_mouse_pos</B> capa-
+ bility.
+
+ Those features required a terminal which had been modified to work
+ with 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
+ use video terminals, making it unnecessary to be concerned about com-
+ patibility with the escape sequences.
+
+ The feature macro <B>NCURSES_MOUSE_VERSION</B> is provided so the preprocessor
+ can be used to test whether these features are present. If the inter-
+ face is changed, the value of <B>NCURSES_MOUSE_VERSION</B> will be increment-
+ ed. These values for <B>NCURSES_MOUSE_VERSION</B> may be specified when con-
+ figuring ncurses:
+
+ 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.
+
+ The order of the <B>MEVENT</B> structure members is not guaranteed. Addition-
+ al fields may be added to the structure in the future.
+
+ Under <B><A HREF="ncurses.3X.html">ncurses(3X)</A></B>, these calls are implemented using either xterm's
+ built-in mouse-tracking API or platform-specific drivers including
+
+ <B>o</B> Alessandro Rubini's gpm server
+
+ <B>o</B> FreeBSD sysmouse
+
+ <B>o</B> OS/2 EMX
+
+ If you are using an unsupported configuration, mouse events will not be
+ visible to <B><A HREF="ncurses.3X.html">ncurses(3X)</A></B> (and the <B>mousemask</B> function will always return
+ <B>0</B>).
+
+ If the terminfo entry contains a <B>XM</B> string, this is used in the xterm
+ mouse driver to control the way the terminal is initialized for mouse
+ operation. The default, if <B>XM</B> is not found, corresponds to private
+ mode 1000 of xterm:
+
+ \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 <I>z</I> 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.
+
+ The <B>ALL_MOUSE_EVENTS</B> class does not include <B>REPORT_MOUSE_POSITION</B>.
+ 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.
+
+
+</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 <B>mousemask</B>. 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 <B>kmous</B> set to
+ "\E[M" (the beginning of the response from xterm for mouse clicks).
+ Other values for <B>kmous</B> 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, <B>ncurses</B> as-
+ sumes that if <B>kmous</B> 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 <B>kmous</B> capability
+ is checked first, allowing the use of newer xterm mouse protocols such
+ as xterm's private mode 1006.
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>, <B><A HREF="curs_slk.3X.html">curs_slk(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
+
+
+
+ <B><A HREF="curs_mouse.3X.html">curs_mouse(3X)</A></B>