aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--man/termkey_strfkey.33
-rw-r--r--termkey.h.in2
2 files changed, 5 insertions, 0 deletions
diff --git a/man/termkey_strfkey.3 b/man/termkey_strfkey.3
index c30f12e..68b301e 100644
--- a/man/termkey_strfkey.3
+++ b/man/termkey_strfkey.3
@@ -43,6 +43,9 @@ The following shortcuts are provided for common combinations of format bits:
.TP
.B TERMKEY_FORMAT_VIM
Shortcut to set \fBALTISMETA\fP and \fBWRAPBRACKET\fP, to give an output close to the format the \fIvim\fP editor uses.
+.TP
+.B TERMKEY_FORMAT_URWID
+Shortcut to set \fBALTISMETA\fP, \fBLONGMOD\fP, \fBLOWERMOD\fP, \fBSPACEMOD\fP and \fBLOWERSPACE\fP, to give an output close to the format the \fIurwid\fP python library uses.
.PP
When formatting a \fBTERMKEY_TYPE_UNICODE\fP key structure, this function uses the \fIutf8\fP member. If this member contains an empty string (i.e. its first character is 0) then this member will be prefilled by the function from the \fIcode.number\fP member. This can be convenient when the key structure is being constructed programatically by user code.
.SH "RETURN VALUE"
diff --git a/termkey.h.in b/termkey.h.in
index 5afe118..f884e55 100644
--- a/termkey.h.in
+++ b/termkey.h.in
@@ -225,6 +225,8 @@ typedef enum {
/* Some useful combinations */
#define TERMKEY_FORMAT_VIM (TERMKEY_FORMAT_ALTISMETA|TERMKEY_FORMAT_WRAPBRACKET)
+#define TERMKEY_FORMAT_URWID (TERMKEY_FORMAT_LONGMOD|TERMKEY_FORMAT_ALTISMETA| \
+ TERMKEY_FORMAT_LOWERMOD|TERMKEY_FORMAT_SPACEMOD|TERMKEY_FORMAT_LOWERSPACE)
size_t termkey_strfkey(TermKey *tk, char *buffer, size_t len, TermKeyKey *key, TermKeyFormat format);
const char *termkey_strpkey(TermKey *tk, const char *str, TermKeyKey *key, TermKeyFormat format);