summaryrefslogtreecommitdiff
path: root/lisp/button.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2015-01-20 20:15:20 +0200
committerEli Zaretskii <eliz@gnu.org>2015-01-20 20:15:20 +0200
commit310f7074519c3ea83e669effb87b2fc5a0d37f67 (patch)
tree17006ca789f298a4cde0289a35263f5b807e34f6 /lisp/button.el
parent3ee38f2000944d50adb2c65bd1af11c464c87950 (diff)
downloademacs-310f7074519c3ea83e669effb87b2fc5a0d37f67.tar.gz
lisp/button.el (button-activate, push-button): Doc fix. (Bug#19628)
Diffstat (limited to 'lisp/button.el')
-rw-r--r--lisp/button.el20
1 files changed, 11 insertions, 9 deletions
diff --git a/lisp/button.el b/lisp/button.el
index 189a1c23a4d..e7602dd7050 100644
--- a/lisp/button.el
+++ b/lisp/button.el
@@ -224,10 +224,10 @@ changes to a supertype are not reflected in its subtypes)."
prop val))))
(defun button-activate (button &optional use-mouse-action)
- "Call BUTTON's action property.
-If USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action
-instead of its normal action; if the button has no mouse-action,
-the normal action is used instead.
+ "Call BUTTON's `action' property.
+If USE-MOUSE-ACTION is non-nil, invoke the button's `mouse-action'
+property instead of `action'; if the button has no `mouse-action',
+the value of `action' is used instead.
The action can either be a marker or a function. If it's a
marker then goto it. Otherwise it it is a function then it is
@@ -429,11 +429,13 @@ instead of starting at the next button."
(defun push-button (&optional pos use-mouse-action)
"Perform the action specified by a button at location POS.
POS may be either a buffer position or a mouse-event. If
-USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action
-instead of its normal action; if the button has no mouse-action,
-the normal action is used instead. The action may be either a
-function to call or a marker to display and is invoked using
-`button-activate' (which see).
+USE-MOUSE-ACTION is non-nil, invoke the button's `mouse-action'
+property instead of its `action' property; if the button has no
+`mouse-action', the value of `action' is used instead.
+
+The action in both cases may be either a function to call or a
+marker to display and is invoked using `button-activate' (which
+see).
POS defaults to point, except when `push-button' is invoked
interactively as the result of a mouse-event, in which case, the