From 24f97118465817c09c28103e7c94252b28fa06aa Mon Sep 17 00:00:00 2001 From: Paul LeoNerd Evans Date: Fri, 27 Nov 2009 14:36:29 +0000 Subject: Return opaque mouse events in the key structure; add a function to interpret this into its component fields --- termkey_getkey.3.sh | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'termkey_getkey.3.sh') diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh index b0ddc68..c4f08ee 100644 --- a/termkey_getkey.3.sh +++ b/termkey_getkey.3.sh @@ -40,13 +40,10 @@ The \fITermKeyKey\fP structure is defined as follows: typedef struct { TermKeyType type; union { - long codepoint; /* TERMKEY_TYPE_UNICODE */ - int number; /* TERMKEY_TYPE_FUNCTION */ - TermKeySym sym; /* TERMKEY_TYPE_KEYSYM */ - struct { - short buttons; - short line, col; - } mouse; /* TERMKEY_TYPE_MOUSE */ + long codepoint; /* TERMKEY_TYPE_UNICODE */ + int number; /* TERMKEY_TYPE_FUNCTION */ + TermKeySym sym; /* TERMKEY_TYPE_KEYSYM */ + char mouse[4] /* TERMKEY_TYPE_MOUSE */ } code; int modifiers; char utf8[7]; @@ -66,7 +63,7 @@ a numbered function key. This value indicates that \fIcode.number\fP is valid, a 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. +a mouse button press, release, or movement. The \fIcode.mouse\fP array should be considered opaque. Use \fBtermkey_interpret_mouse\fP(3) to interpret it. .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. .PP @@ -91,5 +88,6 @@ cat <