aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKim F. Storm2005-01-12 15:33:00 +0000
committerKim F. Storm2005-01-12 15:33:00 +0000
commit51d40dab5df28baaa8456035552c717849b4e22e (patch)
tree4416943fde91d5267a34b9bf5998b9cb07dc665b
parent5364b27cbf68a7a221bb005c797ff1fc800a6d35 (diff)
downloademacs-51d40dab5df28baaa8456035552c717849b4e22e.tar.gz
emacs-51d40dab5df28baaa8456035552c717849b4e22e.zip
(Button Properties, Button Buffer Commands):
Clarify mouse-1 and follow-link functionality.
-rw-r--r--lispref/display.texi17
1 files changed, 10 insertions, 7 deletions
diff --git a/lispref/display.texi b/lispref/display.texi
index 17e4bc57ea0..7b0e72c753f 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -4049,9 +4049,8 @@ the usual Emacs @code{highlight} face.
4049@kindex keymap @r{(button property)} 4049@kindex keymap @r{(button property)}
4050The button's keymap, defining bindings active within the button 4050The button's keymap, defining bindings active within the button
4051region. By default this is the usual button region keymap, stored 4051region. By default this is the usual button region keymap, stored
4052in the variable @code{button-map}, which defines @key{RET}, 4052in the variable @code{button-map}, which defines @key{RET} and
4053@key{mouse-1} (if @var{mouse-1-click-follows-link} is set), 4053@key{mouse-2} to invoke the button.
4054and @key{mouse-2} to invoke the button.
4055 4054
4056@item type 4055@item type
4057@kindex type @r{(button property)} 4056@kindex type @r{(button property)}
@@ -4066,8 +4065,9 @@ A string displayed by the Emacs tool-tip help system; by default,
4066 4065
4067@item follow-link 4066@item follow-link
4068@kindex follow-link @r{(button property)} 4067@kindex follow-link @r{(button property)}
4069The follow-link property, defining how a @key{mouse-1} click behaves 4068The follow-link property, defining how a @key{Mouse-1} click behaves
4070on this button, @xref{Enabling Mouse-1 to Follow Links}. 4069on this button, @xref{Links and Mouse-1}.
4070
4071@item button 4071@item button
4072@kindex button @r{(button property)} 4072@kindex button @r{(button property)}
4073All buttons have a non-@code{nil} @code{button} property, which may be useful 4073All buttons have a non-@code{nil} @code{button} property, which may be useful
@@ -4239,8 +4239,7 @@ These are commands and functions for locating and operating on
4239buttons in an Emacs buffer. 4239buttons in an Emacs buffer.
4240 4240
4241@code{push-button} is the command that a user uses to actually `push' 4241@code{push-button} is the command that a user uses to actually `push'
4242a button, and is bound by default in the button itself to @key{RET}, 4242a button, and is bound by default in the button itself to @key{RET}
4243to @key{mouse-1} (if @var{mouse-1-click-follows-link} is set),
4244and to @key{mouse-2} using a region-specific keymap. Commands 4243and to @key{mouse-2} using a region-specific keymap. Commands
4245that are useful outside the buttons itself, such as 4244that are useful outside the buttons itself, such as
4246@code{forward-button} and @code{backward-button} are additionally 4245@code{forward-button} and @code{backward-button} are additionally
@@ -4248,6 +4247,10 @@ available in the keymap stored in @code{button-buffer-map}; a mode
4248which uses buttons may want to use @code{button-buffer-map} as a 4247which uses buttons may want to use @code{button-buffer-map} as a
4249parent keymap for its keymap. 4248parent keymap for its keymap.
4250 4249
4250If the button has a non-@code{nil} @code{follow-link} property, and
4251@var{mouse-1-click-follows-link} is set, a @key{Mouse-1} click will
4252also activate the @code{push-button} command.
4253
4251@deffn Command push-button &optional pos use-mouse-action 4254@deffn Command push-button &optional pos use-mouse-action
4252@tindex push-button 4255@tindex push-button
4253Perform the action specified by a button at location @var{pos}. 4256Perform the action specified by a button at location @var{pos}.