;;; button.el --- clickable buttons
;;
-;; Copyright (C) 2001 Free Software Foundation, Inc.
+;; Copyright (C) 2001, 2002, 2003, 2004, 2005,
+;; 2006, 2007 Free Software Foundation, Inc.
;;
;; Author: Miles Bader <miles@gnu.org>
;; Keywords: extensions
;;
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;;
;; GNU Emacs is distributed in the hope that it will be useful,
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
\f
;; Globals
+;; Use color for the MS-DOS port because it doesn't support underline.
+;; FIXME if MS-DOS correctly answers the (supports) question, it need
+;; no longer be a special case.
(defface button '((((type pc) (class color))
(:foreground "lightblue"))
- (t :underline t))
+ (((supports :underline t)) :underline t)
+ (t (:foreground "lightblue")))
"Default face used for buttons."
- :group 'faces)
+ :group 'basic-faces)
;;;###autoload
(defvar button-map
(defvar button-buffer-map
(let ((map (make-sparse-keymap)))
(define-key map [?\t] 'forward-button)
+ (define-key map "\e\t" 'backward-button)
(define-key map [backtab] 'backward-button)
map)
"Keymap useful for buffers containing buttons.
;; Prevent insertions adjacent to the text-property buttons from
;; inheriting its properties.
(put 'default-button 'rear-nonsticky t)
-;; Text property buttons don't have a `button' property of their own, so
-;; they inherit this.
-(put 'default-button 'button t)
;; A `category-symbol' property for the default button type
(put 'button 'button-category-symbol 'default-button)
`make-text-button'.
Also see `insert-text-button'."
- (let (prop val)
- (while properties
- (setq prop (pop properties))
- (setq val (pop properties))
- ;; Note that all the following code is basically equivalent to
- ;; `button-put', but we can do it much more efficiently since we
- ;; already have BEG and END.
- (cond ((memq prop '(type :type))
- ;; We translate a `type' property into a `category'
- ;; property, since that's what's actually used by
- ;; text-properties for inheritance.
- (setq prop 'category)
- (setq val (button-category-symbol val)))
- ((eq prop 'category)
- ;; Disallow setting the `category' property directly.
- (error "Button `category' property may not be set directly")))
- ;; Add the property.
- (put-text-property beg end prop val)))
+ (let ((type-entry
+ (or (plist-member properties 'type)
+ (plist-member properties :type))))
+ ;; Disallow setting the `category' property directly.
+ (when (plist-get properties 'category)
+ (error "Button `category' property may not be set directly"))
+ (if (null type-entry)
+ ;; The user didn't specify a `type' property, use the default.
+ (setq properties (cons 'category (cons 'default-button properties)))
+ ;; The user did specify a `type' property. Translate it into a
+ ;; `category' property, which is what's actually used by
+ ;; text-properties for inheritance.
+ (setcar type-entry 'category)
+ (setcar (cdr type-entry)
+ (button-category-symbol (car (cdr type-entry))))))
+ ;; Now add all the text properties at once
+ (add-text-properties beg end
+ ;; Each button should have a non-eq `button'
+ ;; property so that next-single-property-change can
+ ;; detect boundaries reliably.
+ (cons 'button (cons (list t) properties)))
;; Return something that can be used to get at the button.
beg)
(next-button pos))))
(defun previous-button (pos &optional count-current)
- "Return the Nth button before position POS in the current buffer.
+ "Return the previous button before position POS in the current buffer.
If COUNT-CURRENT is non-nil, count any button at POS in the search,
instead of starting at the next button."
- (unless count-current
- (setq pos (previous-single-char-property-change pos 'button)))
- (and (> pos (point-min))
- (or (button-at (1- pos))
- ;; We must have originally been on a button, and are now in
- ;; the inter-button space. Recurse to find a button.
- (previous-button pos))))
+ (let ((button (button-at pos)))
+ (if button
+ (if count-current
+ button
+ ;; We started out on a button, so move to its start and look
+ ;; for the previous button boundary.
+ (setq pos (previous-single-char-property-change
+ (button-start button) 'button))
+ (let ((new-button (button-at pos)))
+ (if new-button
+ ;; We are in a button again; this can happen if there
+ ;; are adjacent buttons (or at bob).
+ (unless (= pos (button-start button)) new-button)
+ ;; We are now in the space between buttons.
+ (previous-button pos))))
+ ;; We started out in the space between buttons.
+ (setq pos (previous-single-char-property-change pos 'button))
+ (or (button-at pos)
+ (and (> pos (point-min))
+ (button-at (1- pos)))))))
\f
;; User commands
(provide 'button)
-;;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
+;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
;;; button.el ends here