diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_mouse.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/curs_mouse.3x.html | 242 |
1 files changed, 0 insertions, 242 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_mouse.3x.html b/ncurses-5.2/doc/html/man/curs_mouse.3x.html deleted file mode 100644 index 6e1ca87..0000000 --- a/ncurses-5.2/doc/html/man/curs_mouse.3x.html +++ /dev/null @@ -1,242 +0,0 @@ -<HTML> -<BODY> -<PRE> -<!-- Manpage converted by man2html 3.0.1 --> - -</PRE> -<H2>NAME</H2><PRE> - <B>getmouse</B>, <B>ungetmouse</B>, <B>mousemask</B>, <B>wenclose</B>, <B>mouse_trafo</B>, - <B>wmouse_trafo</B>, <B>mouseinterval</B> - mouse interface through - curses - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <B>#include</B> <B><curses.h></B> - - <B>typedef</B> <B>unsigned</B> <B>long</B> <B>mmask_t;</B> - - <B>typedef</B> <B>struct</B> - <B>{</B> - <B>short</B> <B>id;</B> <I>/*</I> <I>ID</I> <I>to</I> <I>distinguish</I> <I>multiple</I> <I>devices</I> <I>*/</I> - <B>int</B> <B>x,</B> <B>y,</B> <B>z;</B> <I>/*</I> <I>event</I> <I>coordinates</I> <I>*/</I> - <B>mmask_t</B> <B>bstate;</B> <I>/*</I> <I>button</I> <I>state</I> <I>bits</I> <I>*/</I> - <B>}</B> - <B>MEVENT;</B> - <B>int</B> <B>getmouse(MEVENT</B> <B>*event);</B> - <B>int</B> <B>ungetmouse(MEVENT</B> <B>*event);</B> - <B>mmask_t</B> <B>mousemask(mmask_t</B> <B>newmask,</B> <B>mmask_t</B> <B>*oldmask);</B> - <B>bool</B> <B>wenclose(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B> - <B>bool</B> <B>mouse_trafo(int*</B> <B>pY,</B> <B>int*</B> <B>pX,</B> <B>bool</B> <B>to_screen);</B> - <B>bool</B> <B>wmouse_trafo(const</B> <B>WINDOW*</B> <B>win,</B> <B>int*</B> <B>pY,</B> <B>int*</B> <B>pX,</B> - <B>bool</B> <B>to_screen);</B> - <B>int</B> <B>mouseinterval(int</B> <B>erval);</B> - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - These functions provide an interface to mouse events from - <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>. Mouse events are represented by <B>KEY_MOUSE</B> - pseudo-key values in the <B>wgetch</B> input stream. - - To make mouse events visible, use the <B>mousemask</B> 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 pointer; setting a nonzero mask may turn it on. - Whether this happens is device-dependent. - - Here are the mouse event type masks: - - <I>Name</I> <I>Description</I> - --------------------------------------------------------------------- - 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 - 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 - - Once a class of mouse events have been made visible in a - window, calling the <B>wgetch</B> function on that window may - return <B>KEY_MOUSE</B> as an indicator that a mouse event has - been queued. To read the event data and pop the event off - the queue, call <B>getmouse</B>. This function will return <B>OK</B> if - a mouse event is actually visible in the given window, <B>ERR</B> - otherwise. When <B>getmouse</B> returns <B>OK</B>, the data deposited - as y and x in the event 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 <B>ungetmouse</B> function behaves analogously to <B>ungetch</B>. - It pushes a <B>KEY_MOUSE</B> event onto the input queue, and - associates with that event the given state data and - screen-relative character-cell coordinates. - - The <B>wenclose</B> 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- - wise. It is useful for determining what subset of the - screen windows enclose the location of a mouse event. - - The <B>wmouse_trafo</B> function transforms a given pair of coor- - dinates from stdscr-relative coordinates to screen-rela- - tive coordinates or vice versa. Please remember, that - stdscr-relative coordinates are not always identical to - screen-relative coordinates due to the mechanism to - reserve lines on top or bottom of the screen for other - purposes (ripoff() call, see also slk_... functions). If - the parameter <B>to_screen</B> is <B>TRUE</B>, the pointers <B>pY,</B> <B>pX</B> must - reference the coordinates of a location inside the window - <B>win</B>. They are converted to screen-relative coordinates and - returned through the pointers. If the conversion was suc- - cessful, the function returns <B>TRUE</B>. If one of the parame- - ters was NULL or the location is not inside the window, - <B>FALSE</B> is returned. If <B>to_screen</B> is <B>FALSE</B>, the pointers <B>pY,</B> - <B>pX</B> must reference screen-relative coordinates. They are - converted to stdscr-relative coordinates if the window <B>win</B> - encloses this point. In this case the function returns - <B>TRUE</B>. If one of the parameters is NULL or the point is not - inside the window, <B>FALSE</B> is returned. Please notice, that - the referenced coordinates are only replaced by the con- - verted coordinates if the transformation was successful. - - The <B>mouseinterval</B> function sets the maximum time (in thou- - sands of a second) that can elapse between press and - release events in order for them to be recognized as a - click. This function returns the previous interval value. - The default is one fifth of a second. - - 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 <B>get-</B> - <B>str</B> that expects a linefeed for input-loop termination. - - - -</PRE> -<H2>RETURN VALUE</H2><PRE> - <B>getmouse</B>, <B>ungetmouse</B> and <B>mouseinterval</B> return the integer - <B>ERR</B> upon failure or <B>OK</B> upon successful completion. <B>mouse-</B> - <B>mask</B> returns the mask of reportable events. <B>wenclose</B> and - <B>wmouse_trafo</B> are boolean functions returning <B>TRUE</B> or <B>FALSE</B> - depending on their test result. - - -</PRE> -<H2>PORTABILITY</H2><PRE> - These calls were designed for <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>, and are not - found in SVr4 curses, 4.4BSD curses, or any other previous - version of curses. - - The feature macro <B>NCURSES_MOUSE_VERSION</B> is provided so the - preprocessor can be used to test whether these features - are present (its value is 1). If the interface is - changed, the value of <B>NCURSES_MOUSE_VERSION</B> will be incre- - mented. - - The order of the <B>MEVENT</B> structure members is not guaran- - teed. Additional 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 Alessandro - Rubini's gpm server. If you are using something other - than xterm and there is no gpm daemon running on your - machine, mouse events will not be visible to <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B> - (and the <B>wmousemask</B> function will always return <B>0</B>). - - 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. - - -</PRE> -<H2>BUGS</H2><PRE> - Mouse events under xterm will not in fact be ignored dur- - ing cooked mode, if they have been enabled by <B>wmousemask</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 inter- - preted as a variety of function key. Your terminfo - description must have <B>kmous</B> set to "\E[M" (the beginning - of the response from xterm for mouse clicks). - - Because there are no standard terminal responses that - would serve to identify terminals which support the xterm - mouse protocol, <B>ncurses</B> assumes that if your $DISPLAY - environment variable is set, and <B>kmous</B> is defined in the - terminal description, then the terminal may send mouse - events. - - -</PRE> -<H2>SEE ALSO</H2><PRE> - <B><A HREF="ncurses.3x.html">curses(3x)</A></B>. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</PRE> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> -</BODY> -</HTML> |