diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2016-01-13 19:38:06 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2016-01-13 19:38:06 +0200 |
| commit | d3776e9f7c9e6ae3ac4c5afff0c33bff73665759 (patch) | |
| tree | 71384adcc6713afe3164f2d25143b66271b2f142 | |
| parent | d022b707d654c24171a3baf951ca8e5e13a0b77a (diff) | |
Document the new prefix-command hooks
* doc/lispref/hooks.texi (Standard Hooks): Document
`prefix-command-echo-keystrokes-functions' and
`prefix-command-preserve-state-hook'.
| -rw-r--r-- | doc/lispref/hooks.texi | 16 | ||||
| -rw-r--r-- | etc/NEWS | 7 |
2 files changed, 20 insertions, 3 deletions
diff --git a/doc/lispref/hooks.texi b/doc/lispref/hooks.texi index cbbaa8e5ea..b8f761de30 100644 --- a/doc/lispref/hooks.texi +++ b/doc/lispref/hooks.texi @@ -190,6 +190,22 @@ Hook run when about to switch windows with a mouse command. @item post-self-insert-hook @xref{Keymaps and Minor Modes}. +@item prefix-command-echo-keystrokes-functions +@vindex prefix-command-echo-keystrokes-functions +An abnormal hook run by prefix commands (such as @kbd{C-u}) which +should return a string describing the current prefix state. For +example, @kbd{C-u} produces @samp{C-u-} and @samp{C-u 1 2 3-}. Each +hook function is called with no arguments and should return a string +describing the current prefix state, or @code{nil} if there's no +prefix state. @xref{Prefix Command Arguments}. + +@item prefix-command-preserve-state-hook +@vindex prefix-command-preserve-state-hook +Hook run when a prefix command needs to preserve the prefix by passing +the current prefix command state to the next command. For example, +@kbd{C-u} needs to pass the state to the next command when the user +types @kbd{C-u -} or follows @kbd{C-u} with a digit. + @ignore @item prog-mode-hook @itemx special-mode-hook @@ -1335,9 +1335,10 @@ that happen, `unhandled-file-name-directory' now defaults to calling ** syntax-propertize is now automatically called on-demand during forward parsing functions like `forward-sexp'. -** New hooks prefix-command-echo-keystrokes-functions and -prefix-command-preserve-state-hook, to allow the definition of prefix -commands other than the predefined C-u. ++++ +** New hooks `prefix-command-echo-keystrokes-functions' and +`prefix-command-preserve-state-hook' allow the definition of prefix +commands other than the predefined `C-u'. ** New functions `filepos-to-bufferpos' and `bufferpos-to-filepos'. |