ncurses 5.7 - patch 20090829

[ncurses.git] / man / curs_mouse.3x

diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 865fab1ad88fd6f4faf1a8e92df1d951c9157fd3..8dbabca5bd7bf9e6e91c3a27f37b6d0f88ad61dc 100644 (file)
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2008,2009 Free Software Foundation, Inc.              *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,11 +27,12 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_mouse.3x,v 1.28 2005/05/15 16:18:19 tom Exp $
+.\" $Id: curs_mouse.3x,v 1.32 2009/08/29 18:11:58 tom Exp $

 .TH curs_mouse 3X ""
 .na
 .hy 0
 .SH NAME
 .TH curs_mouse 3X ""
 .na
 .hy 0
 .SH NAME

+\fBhas_mouse\fR,

 \fBgetmouse\fR, \fBungetmouse\fR,
 \fBmousemask\fR, \fBwenclose\fR,
 \fBmouse_trafo\fR, \fBwmouse_trafo\fR,
 \fBgetmouse\fR, \fBungetmouse\fR,
 \fBmousemask\fR, \fBwenclose\fR,
 \fBmouse_trafo\fR, \fBwmouse_trafo\fR,


@@ -53,7 +54,9 @@ typedef struct
 MEVENT;\fR
 .fi
 .br
 MEVENT;\fR
 .fi
 .br

-\fBint getmouse(MEVENT *event);\fR
+\fBbool has_mouse(void);\fR
+.br
+-\fBint getmouse(MEVENT *event);\fR

 .br
 \fBint ungetmouse(MEVENT *event);\fR
 .br
 .br
 \fBint ungetmouse(MEVENT *event);\fR
 .br


@@ -158,22 +161,23 @@ if it is and FALSE otherwise.
 It is useful for determining what subset of
 the screen windows enclose the location of a mouse event.
 .PP
 It is useful for determining what subset of
 the screen windows enclose the location of a mouse event.
 .PP

-The \fBwmouse_trafo\fR function transforms a given pair of coordinates from
-stdscr-relative coordinates to screen-relative coordinates or vice versa.
+The \fBwmouse_trafo\fR function transforms a given pair of coordinates
+from stdscr-relative coordinates
+to coordinates relative to the given window or vice versa.

 Please remember, that stdscr-relative coordinates are not always identical
 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).
+to window-relative coordinates due to the mechanism to reserve lines on top
+or bottom of the screen for other purposes
+(see the \fBripoffline()\fP and \fBslk_init\fR calls, for example).

 If the parameter \fBto_screen\fR is \fBTRUE\fR, the pointers
 If the parameter \fBto_screen\fR is \fBTRUE\fR, the pointers

-\fBpY, pX\fR must reference the coordinates of a location inside the window
-\fBwin\fR.
-They are converted to screen-relative coordinates and returned
+\fBpY, pX\fR must reference the coordinates of a location
+inside the window \fBwin\fR.
+They are converted to window-relative coordinates and returned

 through the pointers.
 If the conversion was successful, the function returns \fBTRUE\fR.
 If one of the parameters was NULL or the location is
 not inside the window, \fBFALSE\fR is returned.
 If \fBto_screen\fR is
 through the pointers.
 If the conversion was successful, the function returns \fBTRUE\fR.
 If one of the parameters was NULL or the location is
 not inside the window, \fBFALSE\fR is returned.
 If \fBto_screen\fR is

-\fBFALSE\fR, the pointers \fBpY, pX\fR must reference screen-relative
+\fBFALSE\fR, the pointers \fBpY, pX\fR must reference window-relative

 coordinates.
 They are converted to stdscr-relative coordinates if the
 window \fBwin\fR encloses this point.
 coordinates.
 They are converted to stdscr-relative coordinates if the
 window \fBwin\fR encloses this point.


@@ -184,6 +188,10 @@ Please notice, that the referenced coordinates
 are only replaced by the converted coordinates if the transformation was
 successful.
 .PP
 are only replaced by the converted coordinates if the transformation was
 successful.
 .PP

+The \fBmouse_trafo\fR function performs the same translation
+as \fBwmouse_trafo\fR,
+using stdscr for \fBwin\fR.
+.PP

 The \fBmouseinterval\fR 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.
 The \fBmouseinterval\fR 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.


@@ -192,6 +200,9 @@ This function returns the previous interval value.
 Use \fBmouseinterval(-1)\fR to obtain the interval without altering it.
 The default is one sixth of a second.
 .PP
 Use \fBmouseinterval(-1)\fR to obtain the interval without altering it.
 The default is one sixth of a second.
 .PP

+The \fBhas_mouse\fP function returns TRUE if the mouse driver has been
+successfully initialized.
+.PP

 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 \fBgetstr\fR that expects a linefeed for input-loop
 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 \fBgetstr\fR that expects a linefeed for input-loop


@@ -251,7 +262,7 @@ Under \fBncurses\fR(3X), these calls are implemented using either
 xterm's built-in mouse-tracking API or
 platform-specific drivers including
 .RS
 xterm's built-in mouse-tracking API or
 platform-specific drivers including
 .RS

-Alessandro Rubini's gpm server.
+Alessandro Rubini's gpm server

 .br
 FreeBSD sysmouse
 .br
 .br
 FreeBSD sysmouse
 .br


@@ -259,7 +270,7 @@ OS/2 EMX
 .RE
 If you are using an unsupported configuration,
 mouse events will not be visible to
 .RE
 If you are using an unsupported configuration,
 mouse events will not be visible to

-\fBncurses\fR(3X) (and the \fBwmousemask\fR function will always
+\fBncurses\fR(3X) (and the \fBmousemask\fR function will always

 return \fB0\fR).
 .PP
 If the terminfo entry contains a \fBXM\fR string,
 return \fB0\fR).
 .PP
 If the terminfo entry contains a \fBXM\fR string,


@@ -276,14 +287,17 @@ for use with touch screens (which may be pressure-sensitive) or with
 3D-mice/trackballs/power gloves.
 .SH BUGS
 Mouse events under xterm will not in fact be ignored during cooked mode,
 3D-mice/trackballs/power gloves.
 .SH BUGS
 Mouse events under xterm will not in fact be ignored during cooked mode,

-if they have been enabled by \fBwmousemask\fR.
+if they have been enabled by \fBmousemask\fR.

 Instead, the xterm mouse
 report sequence will appear in the string read.
 .PP
 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.
 Instead, the xterm mouse
 report sequence will appear in the string read.
 .PP
 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 must have \fBkmous\fR set to "\\E[M" (the beginning
-of the response from xterm for mouse clicks).
+Your terminfo description should have \fBkmous\fR set to "\\E[M"
+(the beginning of the response from xterm for mouse clicks).
+Other values for \fBkmous\fR are permitted,
+but under the same assumption,
+i.e., it is the beginning of the response.

 .PP
 Because there are no standard terminal responses that would serve to identify
 terminals which support the xterm mouse protocol, \fBncurses\fR assumes that
 .PP
 Because there are no standard terminal responses that would serve to identify
 terminals which support the xterm mouse protocol, \fBncurses\fR assumes that


@@ -291,7 +305,9 @@ if your $TERM environment variable contains "xterm",
 or \fBkmous\fR is defined in
 the terminal description, then the terminal may send mouse events.
 .SH SEE ALSO
 or \fBkmous\fR is defined in
 the terminal description, then the terminal may send mouse events.
 .SH SEE ALSO

-\fBcurses\fR(3X).
+\fBcurses\fR(3X),
+\fBcurs_kernel\fR(3X),
+\fBcurs_slk\fR(3X).

 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: