diff options
| author | Glenn Morris <rgm@gnu.org> | 2011-01-22 12:10:17 -0800 |
|---|---|---|
| committer | Glenn Morris <rgm@gnu.org> | 2011-01-22 12:10:17 -0800 |
| commit | 4d265b4d767984d643db79cd17ec74785b20dc2a (patch) | |
| tree | 6d92a586c88d80ba65724b3f5ca0c54369c82d85 /lisp/button.el | |
| parent | 66e0718be8d6a5ee63208b09ce6b37c2242860ca (diff) | |
| download | emacs-4d265b4d767984d643db79cd17ec74785b20dc2a.tar.gz | |
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)
Diffstat (limited to 'lisp/button.el')
| -rw-r--r-- | lisp/button.el | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/lisp/button.el b/lisp/button.el index ef7161213fd..4881d9f8741 100644 --- a/lisp/button.el +++ b/lisp/button.el @@ -1,7 +1,7 @@ ;;; button.el --- clickable buttons ;; -;; Copyright (C) 2001, 2002, 2003, 2004, 2005, -;; 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. +;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, +;; 2010, 2011 Free Software Foundation, Inc. ;; ;; Author: Miles Bader <miles@gnu.org> ;; Keywords: extensions @@ -37,7 +37,9 @@ ;; the button is represented by a marker or buffer-position pointing ;; somewhere in the button. In the latter case, no markers into the ;; 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 ;; 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 `define-button-type'. 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 -large numbers of buttons can also be somewhat faster using -`make-text-button'. +part of the text instead of being a property of the buffer. That is, +this function uses text properties, the other uses overlays. +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. @@ -476,5 +481,4 @@ Returns the button found." (provide 'button) -;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9 ;;; button.el ends here |