Commit 4d265b4d authored by Glenn Morris's avatar Glenn Morris
Browse files

Doc fix for make-text-button.

* doc/lispref/display.texi (Making Buttons): Mention limitation of text buttons.

* lisp/button.el (make-text-button): Doc fix.  (See bug#7881)
parent 66e0718b
2011-01-22 Glenn Morris <rgm@gnu.org>
* display.texi (Making Buttons): Mention limitation of text buttons.
2011-01-08 Chong Yidong <cyd@stupidchicken.com> 2011-01-08 Chong Yidong <cyd@stupidchicken.com>
* files.texi (Directory Names): Move directory-abbrev-alist doc to * files.texi (Directory Names): Move directory-abbrev-alist doc to
...@@ -8681,5 +8685,3 @@ ...@@ -8681,5 +8685,3 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; arch-tag: 985ae0ce-df29-475b-b3f8-4bbcbf6f7fda
...@@ -4962,8 +4962,9 @@ and returns it. ...@@ -4962,8 +4962,9 @@ and returns it.
button actually part of the text instead of being a property of the button actually part of the text instead of being a property of the
buffer. Buttons using text properties do not create markers into the buffer. Buttons using text properties do not create markers into the
buffer, which is important for speed when you use extremely large buffer, which is important for speed when you use extremely large
numbers of buttons. Both functions return the position of the start numbers of buttons. (However, if there is an existing face text
of the new button: property at the site of the button, the button face may not be visible.)
Both functions return the position of the start of the new button:
@defun make-text-button beg end &rest properties @defun make-text-button beg end &rest properties
This makes a button from @var{beg} to @var{end} in the current buffer, using This makes a button from @var{beg} to @var{end} in the current buffer, using
...@@ -5904,7 +5905,3 @@ This hook is used for internal purposes: setting up communication with ...@@ -5904,7 +5905,3 @@ This hook is used for internal purposes: setting up communication with
the window system, and creating the initial window. Users should not the window system, and creating the initial window. Users should not
interfere with it. interfere with it.
@end defvar @end defvar
@ignore
arch-tag: ffdf5714-7ecf-415b-9023-fbc6b409c2c6
@end ignore
2011-01-22 Glenn Morris <rgm@gnu.org>
* button.el (make-text-button): Doc fix. (See bug#7881)
2011-01-22 Chong Yidong <cyd@stupidchicken.com> 2011-01-22 Chong Yidong <cyd@stupidchicken.com>
* simple.el (line-move-visual): Doc fix (Bug#7594). * simple.el (line-move-visual): Doc fix (Bug#7594).
......
;;; button.el --- clickable buttons ;;; button.el --- clickable buttons
;; ;;
;; Copyright (C) 2001, 2002, 2003, 2004, 2005, ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
;; 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. ;; 2010, 2011 Free Software Foundation, Inc.
;; ;;
;; Author: Miles Bader <miles@gnu.org> ;; Author: Miles Bader <miles@gnu.org>
;; Keywords: extensions ;; Keywords: extensions
...@@ -37,7 +37,9 @@ ...@@ -37,7 +37,9 @@
;; the button is represented by a marker or buffer-position pointing ;; the button is represented by a marker or buffer-position pointing
;; somewhere in the button. In the latter case, no markers into the ;; somewhere in the button. In the latter case, no markers into the
;; buffer are retained, which is important for speed if there are are ;; buffer are retained, which is important for speed if there are are
;; extremely large numbers of buttons. ;; extremely large numbers of buttons. Note however that if there is
;; an existing face text-property at the site of the button, the
;; button face may not be visible. Using overlays avoids this.
;; ;;
;; Using `define-button-type' to define default properties for buttons ;; Using `define-button-type' to define default properties for buttons
;; is not necessary, but it is is encouraged, since doing so makes the ;; is not necessary, but it is is encouraged, since doing so makes the
...@@ -289,9 +291,12 @@ button-type from which to inherit other properties; see ...@@ -289,9 +291,12 @@ button-type from which to inherit other properties; see
`define-button-type'. `define-button-type'.
This function is like `make-button', except that the button is actually This function is like `make-button', except that the button is actually
part of the text instead of being a property of the buffer. Creating part of the text instead of being a property of the buffer. That is,
large numbers of buttons can also be somewhat faster using this function uses text properties, the other uses overlays.
`make-text-button'. Creating large numbers of buttons can also be somewhat faster
using `make-text-button'. Note, however, that if there is an existing
face property at the site of the button, the button face may not be visible.
You may want to use `make-button' in that case.
BEG can also be a string, in which case it is made into a button. BEG can also be a string, in which case it is made into a button.
...@@ -476,5 +481,4 @@ Returns the button found." ...@@ -476,5 +481,4 @@ Returns the button found."
(provide 'button) (provide 'button)
;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
;;; button.el ends here ;;; button.el ends here
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment