Document 'buttonize-region' in manual
authorRobert Pluim <rpluim@gmail.com>
Tue, 24 Sep 2024 15:03:49 +0000 (17:03 +0200)
committerRobert Pluim <rpluim@gmail.com>
Tue, 24 Sep 2024 15:03:49 +0000 (17:03 +0200)
It was added in emacs-29, but never added to the lisp reference
manual.

* doc/lispref/display.texi (Making Buttons): Document
'buttonize-region'.

doc/lispref/display.texi

index c0fbde5d96a7019190eda0ea8085a558cf34126b..9075ff678e089ee47d25b009df834c3eab989578 100644 (file)
@@ -7955,6 +7955,15 @@ will be called when the user clicks on the button.  The optional
 is called.  If @code{nil}, the button is used as the parameter instead.
 @end defun
 
+@defun buttonize-region start end callback &optional data help-echo
+Sometimes it's more convenient to convert existing text in a buffer to a
+button instead of inserting new text.  This function makes the region
+between @var{start} and @var{end} into a button.  Arguments
+@var{callback} and @var{data} have the same meanings as for
+@code{buttonize}.  Optional argument @var{help-echo} is used as the
+@code{help-echo} property of the button.
+@end defun
+
 @node Manipulating Buttons
 @subsection Manipulating Buttons
 @cindex manipulating buttons