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

Document the new mouse reporting interface

This commit is contained in:
Paul LeoNerd Evans 2009-11-24 01:37:46 +00:00
parent c9d2bd93fd
commit d1842f8a00
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
termkey_getkey.3.sh
View File

@ -42,7 +42,11 @@ typedef struct {
union { union {
long codepoint; /* TERMKEY_TYPE_UNICODE */ long codepoint; /* TERMKEY_TYPE_UNICODE */
int number; /* TERMKEY_TYPE_FUNCTION */ int number; /* TERMKEY_TYPE_FUNCTION */
TermKeySym sym; /* TERMKEY_TYPE_KEYSYM */ TermKeySym sym; /* TERMKEY_TYPE_KEYSYM */
struct {
short buttons;
short line, col;
} mouse; /* TERMKEY_TYPE_MOUSE */
} code; } code;
int modifiers; int modifiers;
char utf8[7]; char utf8[7];
@ -60,6 +64,9 @@ a numbered function key. This value indicates that \fIcode.number\fP is valid, a
.TP .TP
.B TERMKEY_TYPE_KEYSYM .B TERMKEY_TYPE_KEYSYM
a symbolic key. This value indicates that \fIcode.sym\fP is valid, and contains the symbolic key value. This is an opaque value which may be passed to \fBtermkey_get_keyname\fP(3). a symbolic key. This value indicates that \fIcode.sym\fP is valid, and contains the symbolic key value. This is an opaque value which may be passed to \fBtermkey_get_keyname\fP(3).
.TP
.B TERMKEY_TYPE_MOUSE
a mouse button press, release, or movement. This value indicates that \fIcode.mouse\fP is valid. The structure will contain the button and cursor co-ordinates information from the terminal mouse event. The \fIbuttons\fP value will depend on the terminal's current mouse mode, which is beyond \fIlibtermkey\fP's control.
.PP .PP
The \fImodifiers\fP bitmask is composed of a bitwise-or of the constants \fBTERMKEY_KEYMOD_SHIFT\fP, \fBTERMKEY_KEYMOD_CTRL\fP and \fBTERMKEY_KEYMOD_ALT\fP. The \fImodifiers\fP bitmask is composed of a bitwise-or of the constants \fBTERMKEY_KEYMOD_SHIFT\fP, \fBTERMKEY_KEYMOD_CTRL\fP and \fBTERMKEY_KEYMOD_ALT\fP.
.PP .PP