p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

termkey_interpret_mouse takes const key, does not set modifiers, as that's already done

This commit is contained in:
Paul LeoNerd Evans 2012-04-12 18:03:07 +01:00
parent 8cf0858276
commit 7d6a41eaba
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/termkey_interpret_mouse.3
View File

@ -5,7 +5,7 @@ termkey_interpret_mouse \- interpret opaque mouse event data
.nf
.B #include <termkey.h>
.sp
.BI "TermKeyResult termkey_interpret_mouse(TermKey *" tk ", TermKeyKey *" key ", "
.BI "TermKeyResult termkey_interpret_mouse(TermKey *" tk ", const TermKeyKey *" key ", "
.BI " TermKeyMouseEvent *" ev ", int *" button ", int *" line ", int *" col );
.fi
.sp
@ -31,8 +31,6 @@ the mouse was moved while holding a button; \fIbutton\fP will contain its number
a mouse button was released, or the mouse was moved while no button was pressed. If known, \fIbutton\fP will contain the number of the button released. Not all terminals can report this, so it may be 0 instead.
.PP
The \fIline\fP and \fIcol\fP variables will be filled in with the mouse position, indexed from 1.
.PP
After calling this function, it is possible that the \fImodifiers\fP field of the \fIkey\fP structure will have been set according to the modifiers reported by the terminal. This function will not otherwise alter either the \fIkey\fP or the containing \fItk\fP structure, and will be safe to call again on the same event if required.
.SH "RETURN VALUE"
If passed a \fIkey\fP event of the type \fBTERMKEY_TYPE_MOUSE\fP, this function will return \fBTERMKEY_RES_KEY\fP and will affect the variables whose pointers were passed in, as described above.
.PP