GNU Info

(sawfish.info)Keymaps

---

Next: Event Loop Prev: Commands Up: Top

---

Enter node , (file) or (file)node

Keymaps
*******

   Keymaps are used to associate events with commands. When an event
occurs, the associated command is found and evaluated. A keymap is
simply a list whose first element is the symbol `keymap'.

 - Function: keymapp arg
     Returns `t' if ARG may be used as a keymap.

 - Function: make-keymap
     Returns a newly-created empty keymap.

 - Function: bind-keys keymap &rest bindings
     Installs zero or more key bindings into the keymap KEYMAP, then
     returns KEYMAP.

     Each binding is defined by two elements in the list of BINDINGS,
     the first defines the name of the input event (or the event
     itself) and the second defines the command to be associated with
     the event.

     For example to bind two keys in the keymap KEYMAP; the event `C-f'
     to the command `foo' and the event `C-b' to the command `bar' the
     following form would be used,

          (bind-keys KEYMAP
           "C-f" 'foo
           "C-b" 'bar)

 - Function: unbind-keys KEYMAP &rest KEYS
     Removes the bindings of the events KEYS (these may be the names of
     the events or the event objects themselves) from the keymap KEYMAP.

 - Function: search-keymap event keymap
     Search for a binding of the event EVENT in KEYMAP. If a binding is
     found a cons cell `(COMMAND . EVENT)' is returned.

   There are several pre-defined keymaps that are always available:

`global-keymap'
     Keymap containing bindings active anywhere.

`window-keymap'
     Keymap containing bindings active when a client window is focused.

`root-window-keymap'
     Keymap containing bindings active when the pointer is in the root
     window.

`title-keymap'
`border-keymap'
     Keymaps active in the title and borders of window frames.

`close-button-keymap'
`iconify-button-keymap'
`maximize-button-keymap'
`menu-button-keymap'
     Keymaps active in the standard window frame buttons.