-;;; button.el --- Clickable buttons
+;;; button.el --- clickable buttons
;;
;; Copyright (C) 2001 Free Software Foundation, Inc.
;;
\f
;; Globals
-(defface button '((t :underline t))
+(defface button '((((type pc) (class color))
+ (:foreground "lightblue"))
+ (t :underline t))
"Default face used for buttons.")
;;;###autoload
;; they inherit this.
(put 'default-button 'button t)
+;; A `category-symbol' property for the default button type
+(put 'button 'button-category-symbol 'default-button)
+
\f
;; Button types (which can be used to hold default properties for buttons)
The remaining arguments form a sequence of PROPERTY VALUE pairs,
specifying properties to use as defaults for buttons with this type
\(a button's type may be set by giving it a `type' property when
-creating the button).
-
-The property `supertype' may be used to specify a button-type from which
-NAME inherits its default property values \(however, the inheritance
-happens only when NAME is defined; subsequent changes to a supertype are
-not reflected in its subtypes)."
- (let* ((catsym (make-symbol (concat (symbol-name name) "-button")))
- (supertype (plist-get properties 'supertype))
- (super-catsym
- (if supertype (button-category-symbol supertype) 'default-button)))
+creating the button, using the :type keyword argument).
+
+In addition, the keyword argument :supertype may be used to specify a
+button-type from which NAME inherits its default property values
+\(however, the inheritance happens only when NAME is defined; subsequent
+changes to a supertype are not reflected in its subtypes)."
+ (let ((catsym (make-symbol (concat (symbol-name name) "-button")))
+ (super-catsym
+ (button-category-symbol
+ (or (plist-get properties 'supertype)
+ (plist-get properties :supertype)
+ 'button))))
;; Provide a link so that it's easy to find the real symbol.
(put name 'button-category-symbol catsym)
;; Initialize NAME's properties using the global defaults.
(put catsym 'type name)
;; Add the properties in PROPERTIES to the real symbol.
(while properties
- (put catsym (pop properties) (pop properties)))
+ (let ((prop (pop properties)))
+ (when (eq prop :supertype)
+ (setq prop 'supertype))
+ (put catsym prop (pop properties))))
+ ;; Make sure there's a `supertype' property
+ (unless (get catsym 'supertype)
+ (put catsym 'supertype 'button))
name))
(defun button-type-put (type prop val)
(defun button-put (button prop val)
"Set BUTTON's PROP property to VAL."
;; Treat some properties specially.
- (cond ((eq prop 'type)
+ (cond ((memq prop '(type :type))
;; We translate a `type' property a `category' property, since
;; that's what's actually used by overlays/text-properties for
;; inheriting properties.
"Return BUTTON's text label."
(buffer-substring-no-properties (button-start button) (button-end button)))
+(defsubst button-type (button)
+ "Return BUTTON's button-type."
+ (button-get button 'type))
+
(defun button-has-type-p (button type)
"Return t if BUTTON has button-type TYPE, or one of TYPE's subtypes."
(button-type-subtype-p (button-get button 'type) type))
(defun make-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button. In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
Also see `make-text-button', `insert-button'."
(let ((overlay (make-overlay beg end nil t nil)))
(defun insert-button (label &rest properties)
"Insert a button with the label LABEL.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button. In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
Also see `insert-text-button', `make-button'."
(apply #'make-button
(defun make-text-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button. In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+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
;; 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 ((eq prop 'type)
+ (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.
(defun insert-text-button (label &rest properties)
"Insert a button with the label LABEL.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
-specifying properties to add to the button. In particular, the `type'
-property may be used to specify a button-type from which to inherit
-other properties; see `define-button-type'.
+specifying properties to add to the button.
+In addition, the keyword argument :type may be used to specify a
+button-type from which to inherit other properties; see
+`define-button-type'.
This function is like `insert-button', except that the button is
actually part of the text instead of being a property of the buffer.