aboutsummaryrefslogtreecommitdiff
path: root/termkey_getkey.3.sh
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2009-07-15 20:40:44 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2009-07-15 20:40:44 +0100
commitbe998cef1b8a46391956dc212ef3bf1351da0f3a (patch)
treeb5634e51fc74ca524f94a05ece2ddc430994ec58 /termkey_getkey.3.sh
parentaf50967d12929b5745e868796ba50e4ee9b54f6d (diff)
downloadtermo-be998cef1b8a46391956dc212ef3bf1351da0f3a.tar.gz
termo-be998cef1b8a46391956dc212ef3bf1351da0f3a.tar.xz
termo-be998cef1b8a46391956dc212ef3bf1351da0f3a.zip
Renamed all type names to CamelCaseNames for visual distinctness, separate from variables/functions
Diffstat (limited to 'termkey_getkey.3.sh')
-rw-r--r--termkey_getkey.3.sh12
1 files changed, 6 insertions, 6 deletions
diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh
index 33e7f23..83ef9db 100644
--- a/termkey_getkey.3.sh
+++ b/termkey_getkey.3.sh
@@ -7,9 +7,9 @@ termkey_getkey, termkey_getkey_force \- retrieve the next key event
.nf
.B #include <termkey.h>
.sp
-.BI "termkey_result termkey_getkey(termkey_t *" tk ", termkey_key *" key );
+.BI "TermKeyResult termkey_getkey(TermKey *" tk ", TermKeyKey *" key );
.br
-.BI "termkey_result termkey_getkey_force(termkey_t *" tk ", termkey_key *" key );
+.BI "TermKeyResult termkey_getkey_force(TermKey *" tk ", TermKeyKey *" key );
.fi
.sp
Link with \fI-ltermkey\fP.
@@ -33,20 +33,20 @@ no bytes are waiting in the buffer.
.PP
Neither of these functions will block or perform any IO operations on the underlying filehandle. To use the instance in an asynchronous program, see \fBtermkey_advisereadable\fP(3). For a blocking call suitable for use in a synchronous program, use \fBtermkey_waitkey\fP(3) instead of \fBtermkey_getkey\fP().
.PP
-The \fItermkey_key\fP structure is defined as follows:
+The \fITermKeyKey\fP structure is defined as follows:
.PP
.in +4n
.nf
typedef struct {
- termkey_type type;
+ TermKeyType type;
union {
long codepoint; /* TERMKEY_TYPE_UNICODE */
int number; /* TERMKEY_TYPE_FUNCTION */
- termkey_keysym sym; /* TERMKEY_TYPE_KEYSYM */
+ TermKeySym sym; /* TERMKEY_TYPE_KEYSYM */
} code;
int modifiers;
char utf8[7];
-} termkey_key;
+} TermKeyKey;
.fi
.in
.PP