aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2006-02-11 13:55:42 +0000
committerEli Zaretskii2006-02-11 13:55:42 +0000
commit6527c9830762f84afba0e2abc0da70dd46c9ac0b (patch)
tree287997d1f4374ee71c26d2cd553e8d0935685083
parent9d56e0da1fe2128b9c7ffdf05f5f7b9ad2ece9fc (diff)
downloademacs-6527c9830762f84afba0e2abc0da70dd46c9ac0b.tar.gz
emacs-6527c9830762f84afba0e2abc0da70dd46c9ac0b.zip
(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.
-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."
556 string 556 string
557 (format "%s (translated from %s)" string otherstring)))))) 557 (format "%s (translated from %s)" string otherstring))))))
558 558
559(defun describe-key-briefly (key &optional insert untranslated) 559(defun describe-key-briefly (&optional key insert untranslated)
560 "Print the name of the function KEY invokes. KEY is a string.
561If INSERT (the prefix arg) is non-nil, insert the message in the buffer.
562If non-nil, UNTRANSLATED is a vector of the untranslated events.
563It can also be a number in which case the untranslated events from
564the last key hit are used.
565
566If KEY is a menu item or a tool-bar button that is disabled, this command
567temporarily enables it to allow clicking on disabled items and buttons."
568 (interactive)
569 (let ((enable-disabled-menus-and-buttons t))
570 (if key
571 ;; Non-interactive invocation
572 (describe-key-briefly-internal key insert untranslated)
573 (call-interactively 'describe-key-briefly-internal))))
574
575(defun describe-key-briefly-internal (key &optional insert untranslated)
560 "Print the name of the function KEY invokes. KEY is a string. 576 "Print the name of the function KEY invokes. KEY is a string.
561If INSERT (the prefix arg) is non-nil, insert the message in the buffer. 577If INSERT (the prefix arg) is non-nil, insert the message in the buffer.
562If non-nil UNTRANSLATED is a vector of the untranslated events. 578If non-nil UNTRANSLATED is a vector of the untranslated events.
@@ -601,7 +617,27 @@ the last key hit are used."
601 key-desc 617 key-desc
602 (if (symbolp defn) defn (prin1-to-string defn))))))))) 618 (if (symbolp defn) defn (prin1-to-string defn)))))))))
603 619
604(defun describe-key (key &optional untranslated up-event) 620(defun describe-key (&optional key untranslated up-event)
621 "Display documentation of the function invoked by KEY.
622KEY can be any kind of a key sequence; it can include keyboard events,
623mouse events, and/or menu events. When calling from a program,
624pass KEY as a string or a vector.
625
626If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events.
627It can also be a number, in which case the untranslated events from
628the last key sequence entered are used.
629UP-EVENT is the up-event that was discarded by reading KEY, or nil.
630
631If KEY is a menu item or a tool-bar button that is disabled, this command
632temporarily enables it to allow clicking on disabled items and buttons."
633 (interactive)
634 (let ((enable-disabled-menus-and-buttons t))
635 (if key
636 ;; Non-interactive invocation
637 (describe-key-internal key untranslated up-event)
638 (call-interactively 'describe-key-internal))))
639
640(defun describe-key-internal (key &optional untranslated up-event)
605 "Display documentation of the function invoked by KEY. 641 "Display documentation of the function invoked by KEY.
606KEY can be any kind of a key sequence; it can include keyboard events, 642KEY can be any kind of a key sequence; it can include keyboard events,
607mouse events, and/or menu events. When calling from a program, 643mouse events, and/or menu events. When calling from a program,
@@ -609,8 +645,8 @@ pass KEY as a string or a vector.
609 645
610If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events. 646If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events.
611It can also be a number, in which case the untranslated events from 647It can also be a number, in which case the untranslated events from
612the last key sequence entered are used." 648the last key sequence entered are used.
613 ;; UP-EVENT is the up-event that was discarded by reading KEY, or nil. 649UP-EVENT is the up-event that was discarded by reading KEY, or nil."
614 (interactive "kDescribe key (or click or menu item): \np\nU") 650 (interactive "kDescribe key (or click or menu item): \np\nU")
615 (if (numberp untranslated) 651 (if (numberp untranslated)
616 (setq untranslated (this-single-command-raw-keys))) 652 (setq untranslated (this-single-command-raw-keys)))