summaryrefslogtreecommitdiff
path: root/lisp/help.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2006-02-11 13:55:42 +0000
committerEli Zaretskii <eliz@gnu.org>2006-02-11 13:55:42 +0000
commit6527c9830762f84afba0e2abc0da70dd46c9ac0b (patch)
tree287997d1f4374ee71c26d2cd553e8d0935685083 /lisp/help.el
parent9d56e0da1fe2128b9c7ffdf05f5f7b9ad2ece9fc (diff)
downloademacs-6527c9830762f84afba0e2abc0da70dd46c9ac0b.tar.gz
(describe-key-briefly): Now a wrapper for describe-key-briefly-internal.
Bind enable-disabled-menus-and-buttons to t. (describe-key-briefly-internal): Renamed from describe-key-briefly. (describe-key): Now a wrapper for describe-key-internal. Bind enable-disabled-menus-and-buttons to t. (describe-key-internal): Renamed from describe-key.
Diffstat (limited to 'lisp/help.el')
-rw-r--r--lisp/help.el44
1 files changed, 40 insertions, 4 deletions
diff --git a/lisp/help.el b/lisp/help.el
index f8ed27810ea..b010722bec0 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -556,7 +556,23 @@ or `keymap' property, return the binding of KEY in the string's keymap."
string
(format "%s (translated from %s)" string otherstring))))))
-(defun describe-key-briefly (key &optional insert untranslated)
+(defun describe-key-briefly (&optional key insert untranslated)
+ "Print the name of the function KEY invokes. KEY is a string.
+If INSERT (the prefix arg) is non-nil, insert the message in the buffer.
+If non-nil, UNTRANSLATED is a vector of the untranslated events.
+It can also be a number in which case the untranslated events from
+the last key hit are used.
+
+If KEY is a menu item or a tool-bar button that is disabled, this command
+temporarily enables it to allow clicking on disabled items and buttons."
+ (interactive)
+ (let ((enable-disabled-menus-and-buttons t))
+ (if key
+ ;; Non-interactive invocation
+ (describe-key-briefly-internal key insert untranslated)
+ (call-interactively 'describe-key-briefly-internal))))
+
+(defun describe-key-briefly-internal (key &optional insert untranslated)
"Print the name of the function KEY invokes. KEY is a string.
If INSERT (the prefix arg) is non-nil, insert the message in the buffer.
If non-nil UNTRANSLATED is a vector of the untranslated events.
@@ -601,7 +617,27 @@ the last key hit are used."
key-desc
(if (symbolp defn) defn (prin1-to-string defn)))))))))
-(defun describe-key (key &optional untranslated up-event)
+(defun describe-key (&optional key untranslated up-event)
+ "Display documentation of the function invoked by KEY.
+KEY can be any kind of a key sequence; it can include keyboard events,
+mouse events, and/or menu events. When calling from a program,
+pass KEY as a string or a vector.
+
+If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events.
+It can also be a number, in which case the untranslated events from
+the last key sequence entered are used.
+UP-EVENT is the up-event that was discarded by reading KEY, or nil.
+
+If KEY is a menu item or a tool-bar button that is disabled, this command
+temporarily enables it to allow clicking on disabled items and buttons."
+ (interactive)
+ (let ((enable-disabled-menus-and-buttons t))
+ (if key
+ ;; Non-interactive invocation
+ (describe-key-internal key untranslated up-event)
+ (call-interactively 'describe-key-internal))))
+
+(defun describe-key-internal (key &optional untranslated up-event)
"Display documentation of the function invoked by KEY.
KEY can be any kind of a key sequence; it can include keyboard events,
mouse events, and/or menu events. When calling from a program,
@@ -609,8 +645,8 @@ pass KEY as a string or a vector.
If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events.
It can also be a number, in which case the untranslated events from
-the last key sequence entered are used."
- ;; UP-EVENT is the up-event that was discarded by reading KEY, or nil.
+the last key sequence entered are used.
+UP-EVENT is the up-event that was discarded by reading KEY, or nil."
(interactive "kDescribe key (or click or menu item): \np\nU")
(if (numberp untranslated)
(setq untranslated (this-single-command-raw-keys)))