aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGravatar keis <keijser@gmail.com>2011-03-14 20:53:31 +0100
committerGravatar Brendan Taylor <whateley@gmail.com>2011-04-18 20:23:43 -0600
commit354d530231cb06fb8aa046b1a6442586aec8847f (patch)
tree0c774ba5fc9af3e4bdaad04a5740752875b5a622 /docs
parent16f10abea2c634b462ba7157e63383b076b75bcc (diff)
keycmd comments and docs
Diffstat (limited to 'docs')
-rw-r--r--docs/README.uzbl-event-manager27
1 files changed, 24 insertions, 3 deletions
diff --git a/docs/README.uzbl-event-manager b/docs/README.uzbl-event-manager
index 23e185c..da26847 100644
--- a/docs/README.uzbl-event-manager
+++ b/docs/README.uzbl-event-manager
@@ -26,15 +26,36 @@ MODE_CHANGE <mode>
### keycmd.py ###
- Tracks the currently entered command
-- Connects To: FOCUS_GAINED, FOCUS_LOST, KEY_PRESS, KEY_RELEASE, (APPEND_KEYCMD,
+- Connects To: KEY_PRESS, KEY_RELEASE, MOD_PRESS, MOD_RELEASE, (APPEND_KEYCMD,
IGNORE_KEY, INJECT_KEYCMD, KEYCMD_BACKSPACE, KEYCMD_DELETE,
- KEYCMD_EXEC_CURRENT, KEYCMD_STRIP_WORD, MODKEY_ADDITION, MODMAP,
+ KEYCMD_EXEC_CURRENT, KEYCMD_STRIP_WORD, KEYCMD_CLEAR, MODMAP,
SET_CURSOR_POS, SET_KEYCMD)
-- Emits: KEYCMD_UPDATE, KEYCMD_EXEC, MODCMD_UPDATE, MODCMD_EXEC
+- Emits: KEYCMD_UPDATE, KEYCMD_EXEC, MODCMD_UPDATE, MODCMD_EXEC, KEYCMD_CLEARED
+ MODCMD_CLEARED
Maintains a command line that is manipulated by simple keypresses and a number
of events.
+APPEND_KEYCMD <str>
+ Appends `str` to the end of the keycmd
+
+INJECT_KEYCMD <str>
+ Inserts `str` at the cursor position
+
+KEYCMD_BACKSPACE
+ Removes the character at the cursor position in the keycmd
+
+KEYCMD_DELETE
+ Removes the character after the cursor position in the keycmd
+
+KEYCMD_EXEC_CURRENT
+ Raise a KEYCMD_EXEC with the current keylet and then clear the keycmd
+
+KEYCMD_STRIP_WORD [<separator>]
+ Removes the last word from the keycmd, similar to readline ^W
+
+KEYCMD_CLEAR
+ Clears the keycmd and raises KEYCMD_CLEARED
### bind.py ###
- Provides support for key bindings