ncurses 5.7 - patch 20100206

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

diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 16bc45df2d20966a7570aed4396c959478faa2bf..7353dd3eead0fdd824f77df22f3db28e38267947 100644 (file)
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2009,2010 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,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_mouse.3x,v 1.31 2008/11/23 00:09:53 tom Exp $
+.\" $Id: curs_mouse.3x,v 1.35 2010/01/30 20:58:50 tom Exp $

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


@@ -56,7 +56,7 @@ MEVENT;\fR
 .br
 \fBbool has_mouse(void);\fR
 .br
 .br
 \fBbool has_mouse(void);\fR
 .br

--\fBint getmouse(MEVENT *event);\fR
+\fBint getmouse(MEVENT *event);\fR

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


@@ -149,6 +149,9 @@ 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.
 coordinates.
 The returned state mask will have exactly one bit set to
 indicate the event type.

+The corresponding data in the queue is marked invalid.
+A subsequent call to \fBgetmouse\fP will retrieve the next older
+item from the queue.

 .PP
 The \fBungetmouse\fR function behaves analogously to \fBungetch\fR.
 It pushes
 .PP
 The \fBungetmouse\fR function behaves analogously to \fBungetch\fR.
 It pushes


@@ -217,6 +220,7 @@ upon successful completion.
 returns an error.
 If no mouse driver was initialized, or
 if the mask parameter is zero,
 returns an error.
 If no mouse driver was initialized, or
 if the mask parameter is zero,

+it also returns an error if no more events remain in the queue.

 .TP 5
 \fBungetmouse\fP
 returns an error if the FIFO is full.
 .TP 5
 \fBungetmouse\fP
 returns an error if the FIFO is full.


@@ -262,7 +266,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