X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_mouse.3x;fp=man%2Fcurs_mouse.3x;h=7140261f459d5e9c67bac57f1cef9bd7eb06e19c;hp=8dbabca5bd7bf9e6e91c3a27f37b6d0f88ad61dc;hb=40cf934fff2d2790c060619e3a29bd54c20994b0;hpb=2debf76e0c23a2b3d1333f0853317a7b2ae1777f diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x index 8dbabca5..7140261f 100644 --- a/man/curs_mouse.3x +++ b/man/curs_mouse.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2008,2009 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_mouse.3x,v 1.32 2009/08/29 18:11:58 tom Exp $ +.\" $Id: curs_mouse.3x,v 1.34 2010/01/02 21:45:42 tom Exp $ .TH curs_mouse 3X "" .na .hy 0 @@ -56,7 +56,7 @@ MEVENT;\fR .br \fBbool has_mouse(void);\fR .br --\fBint getmouse(MEVENT *event);\fR +\fBint getmouse(MEVENT *event);\fR .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. +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 @@ -217,6 +220,7 @@ upon successful completion. 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.