diff options
Diffstat (limited to 'upstream/mageia-cauldron/man3/curs_mouse.3x')
| -rw-r--r-- | upstream/mageia-cauldron/man3/curs_mouse.3x | 34 |
1 files changed, 21 insertions, 13 deletions
diff --git a/upstream/mageia-cauldron/man3/curs_mouse.3x b/upstream/mageia-cauldron/man3/curs_mouse.3x index 9c9048f7..70bc5e93 100644 --- a/upstream/mageia-cauldron/man3/curs_mouse.3x +++ b/upstream/mageia-cauldron/man3/curs_mouse.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_mouse.3x,v 1.89 2024/02/17 21:43:03 tom Exp $ -.TH curs_mouse 3X 2024-02-17 "ncurses 6.4" "Library calls" +.\" $Id: curs_mouse.3x,v 1.96 2024/03/23 20:38:57 tom Exp $ +.TH curs_mouse 3X 2024-03-23 "ncurses 6.4" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -103,7 +103,7 @@ If \fIoldmask\fP is non-\fBNULL\fP, this function fills the indicated location with the previous value of the current screen's mouse event mask. .PP -As a side effect, setting a zero mousemask may turn off the mouse pointer; +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. .SS "Mouse Events" @@ -188,8 +188,8 @@ the screen windows enclose the location of a mouse event. If the parameter is a pad, \fB\%wenclose\fP uses the most recent screen coordinates used for this pad in -\fP\%prefresh\fP(3X) or -\fP\%pnoutrefresh\fP(3X). +\fB\%prefresh\fP(3X) or +\fB\%pnoutrefresh\fP(3X). .SS wmouse_trafo The \fB\%wmouse_trafo\fP function transforms a given pair of coordinates from \fB\%stdscr\fP-relative coordinates @@ -197,7 +197,7 @@ to coordinates relative to the given window or vice versa. The resulting \fB\%stdscr\fP-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 \fB\%ripoffline\fP and \fB\%slk_init\fP(3X) calls, for example). +(see the \fB\%ripoffline\fP(3X) and \fB\%slk_init\fP(3X) calls, for example). .bP If the parameter \fIto_screen\fP is \fBTRUE\fP, the pointers \fIpY, pX\fP must reference the coordinates of a location @@ -230,10 +230,18 @@ using \fB\%stdscr\fP for \fIwin\fP. The \fB\%mouseinterval\fP function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to -be resolved as a click. +be resolved as a +.IR click . +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\*(''. .PP Calling \fB\%mouseinterval(0)\fP disables click resolution. -When ncurses detects a mouse event, +When +.I \%ncurses +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. @@ -291,7 +299,7 @@ The order of the \fB\%MEVENT\fP structure members is not guaranteed. Additional fields may be added to the structure in the future. .PP Under -.I \%ncurses, +.IR \%ncurses , these calls are implemented using either .IR \%xterm 's built-in mouse-tracking API or @@ -344,7 +352,7 @@ include \fB\%REPORT_MOUSE_POSITION\fP. They are distinct. For example, in -.I \%xterm, +.IR \%xterm , wheel/scrolling mice send position reports as a sequence of presses of buttons 4 or 5 without matching button-releases. .SH EXTENSIONS @@ -448,9 +456,9 @@ where the mouse was using the \fB\%req_mouse_pos\fP capability. .IP Those features required a terminal program that had been modified to work with SVr4 -.I curses. +.IR curses . They were not part of the X Consortium's -.I \%xterm. +.IR \%xterm . .PP When developing the .I \%xterm @@ -462,7 +470,7 @@ lack of documentation. Later, in 1998, Mark Hesseling provided support in .I \%PDCurses 2.3 using the SVr4 interface. -.I \%PDCurses, +.IR \%PDCurses , however, does not use video terminals, making it unnecessary to be concerned about compatibility with the |