annotate lisp/button.el @ 59611:2595b97b13bd

*** empty log message ***
author Kenichi Handa <handa@m17n.org>
date Tue, 18 Jan 2005 00:14:18 +0000
parents 12ad045f7911
children 82eaf594d12a ff0e824afa37
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
42497
4c6b45c79a59 Fix header.
Pavel Janík <Pavel@Janik.cz>
parents: 40595
diff changeset
1 ;;; button.el --- clickable buttons
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
2 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 2001 Free Software Foundation, Inc.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
4 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
5 ;; Author: Miles Bader <miles@gnu.org>
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
6 ;; Keywords: extensions
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
7 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
9 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
13 ;; any later version.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
14 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
19 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
23 ;; Boston, MA 02111-1307, USA.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
24
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
25 ;;; Commentary:
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
26 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
27 ;; This package defines functions for inserting and manipulating
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
28 ;; clickable buttons in Emacs buffers, such as might be used for help
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
29 ;; hyperlinks, etc.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
30 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
31 ;; In some ways it duplicates functionality also offered by the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
32 ;; `widget' package, but the button package has the advantage that it
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
33 ;; is (1) much faster, (2) much smaller, and (3) much, much, simpler
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
34 ;; (the code, that is, not the interface).
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
35 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
36 ;; Buttons can either use overlays, in which case the button is
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
37 ;; represented by the overlay itself, or text-properties, in which case
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
38 ;; the button is represented by a marker or buffer-position pointing
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
39 ;; somewhere in the button. In the latter case, no markers into the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
40 ;; buffer are retained, which is important for speed if there are are
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
41 ;; extremely large numbers of buttons.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
42 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
43 ;; Using `define-button-type' to define default properties for buttons
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
44 ;; is not necessary, but it is is encouraged, since doing so makes the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
45 ;; resulting code clearer and more efficient.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
46 ;;
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
47
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
48 ;;; Code:
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
49
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
50
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
51 ;; Globals
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
52
40337
57f029917c77 (button): Special face definition for MS-DOS terminals.
Eli Zaretskii <eliz@gnu.org>
parents: 39917
diff changeset
53 (defface button '((((type pc) (class color))
57f029917c77 (button): Special face definition for MS-DOS terminals.
Eli Zaretskii <eliz@gnu.org>
parents: 39917
diff changeset
54 (:foreground "lightblue"))
57f029917c77 (button): Special face definition for MS-DOS terminals.
Eli Zaretskii <eliz@gnu.org>
parents: 39917
diff changeset
55 (t :underline t))
49001
85b083d06a17 (defface button): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 42497
diff changeset
56 "Default face used for buttons."
85b083d06a17 (defface button): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 42497
diff changeset
57 :group 'faces)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
58
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
59 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
60 (defvar button-map
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
61 (let ((map (make-sparse-keymap)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
62 (define-key map "\r" 'push-button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
63 (define-key map [mouse-2] 'push-button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
64 map)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
65 "Keymap used by buttons.")
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
66
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
67 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
68 (defvar button-buffer-map
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
69 (let ((map (make-sparse-keymap)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
70 (define-key map [?\t] 'forward-button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
71 (define-key map [backtab] 'backward-button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
72 map)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
73 "Keymap useful for buffers containing buttons.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
74 Mode-specific keymaps may want to use this as their parent keymap.")
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
75
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
76 ;; Default properties for buttons
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
77 (put 'default-button 'face 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
78 (put 'default-button 'mouse-face 'highlight)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
79 (put 'default-button 'keymap button-map)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
80 (put 'default-button 'type 'button)
57483
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
81 ;; action may be either a function to call, or a marker to go to
39703
a093c43d935c (button-nop): Function removed.
Miles Bader <miles@gnu.org>
parents: 39676
diff changeset
82 (put 'default-button 'action 'ignore)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
83 (put 'default-button 'help-echo "mouse-2, RET: Push this button")
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
84 ;; Make overlay buttons go away if their underlying text is deleted.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
85 (put 'default-button 'evaporate t)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
86 ;; Prevent insertions adjacent to the text-property buttons from
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
87 ;; inheriting its properties.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
88 (put 'default-button 'rear-nonsticky t)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
89 ;; Text property buttons don't have a `button' property of their own, so
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
90 ;; they inherit this.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
91 (put 'default-button 'button t)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
92
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
93 ;; A `category-symbol' property for the default button type
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
94 (put 'button 'button-category-symbol 'default-button)
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
95
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
96
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
97 ;; Button types (which can be used to hold default properties for buttons)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
98
39716
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
99 ;; Because button-type properties are inherited by buttons using the
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
100 ;; special `category' property (implemented by both overlays and
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
101 ;; text-properties), we need to store them on a symbol to which the
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
102 ;; `category' properties can point. Instead of using the symbol that's
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
103 ;; the name of each button-type, however, we use a separate symbol (with
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
104 ;; `-button' appended, and uninterned) to store the properties. This is
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
105 ;; to avoid name clashes.
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
106
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
107 ;; [this is an internal function]
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
108 (defsubst button-category-symbol (type)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
109 "Return the symbol used by button-type TYPE to store properties.
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
110 Buttons inherit them by setting their `category' property to that symbol."
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
111 (or (get type 'button-category-symbol)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
112 (error "Unknown button type `%s'" type)))
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
113
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
114 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
115 (defun define-button-type (name &rest properties)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
116 "Define a `button type' called NAME.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
117 The remaining arguments form a sequence of PROPERTY VALUE pairs,
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
118 specifying properties to use as defaults for buttons with this type
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
119 \(a button's type may be set by giving it a `type' property when
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
120 creating the button, using the :type keyword argument).
39716
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
121
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
122 In addition, the keyword argument :supertype may be used to specify a
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
123 button-type from which NAME inherits its default property values
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
124 \(however, the inheritance happens only when NAME is defined; subsequent
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
125 changes to a supertype are not reflected in its subtypes)."
40595
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
126 (let ((catsym (make-symbol (concat (symbol-name name) "-button")))
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
127 (super-catsym
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
128 (button-category-symbol
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
129 (or (plist-get properties 'supertype)
40595
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
130 (plist-get properties :supertype)
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
131 'button))))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
132 ;; Provide a link so that it's easy to find the real symbol.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
133 (put name 'button-category-symbol catsym)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
134 ;; Initialize NAME's properties using the global defaults.
39716
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
135 (let ((default-props (symbol-plist super-catsym)))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
136 (while default-props
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
137 (put catsym (pop default-props) (pop default-props))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
138 ;; Add NAME as the `type' property, which will then be returned as
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
139 ;; the type property of individual buttons.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
140 (put catsym 'type name)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
141 ;; Add the properties in PROPERTIES to the real symbol.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
142 (while properties
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
143 (let ((prop (pop properties)))
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
144 (when (eq prop :supertype)
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
145 (setq prop 'supertype))
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
146 (put catsym prop (pop properties))))
40595
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
147 ;; Make sure there's a `supertype' property
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
148 (unless (get catsym 'supertype)
3ba2b666d7e1 (define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents: 40337
diff changeset
149 (put catsym 'supertype 'button))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
150 name))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
151
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
152 (defun button-type-put (type prop val)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
153 "Set the button-type TYPE's PROP property to VAL."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
154 (put (button-category-symbol type) prop val))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
155
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
156 (defun button-type-get (type prop)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
157 "Get the property of button-type TYPE named PROP."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
158 (get (button-category-symbol type) prop))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
159
39716
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
160 (defun button-type-subtype-p (type supertype)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
161 "Return t if button-type TYPE is a subtype of SUPERTYPE."
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
162 (or (eq type supertype)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
163 (and type
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
164 (button-type-subtype-p (button-type-get type 'supertype)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
165 supertype))))
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
166
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
167
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
168 ;; Button properties and other attributes
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
169
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
170 (defun button-start (button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
171 "Return the position at which BUTTON starts."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
172 (if (overlayp button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
173 (overlay-start button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
174 ;; Must be a text-property button.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
175 (or (previous-single-property-change (1+ button) 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
176 (point-min))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
177
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
178 (defun button-end (button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
179 "Return the position at which BUTTON ends."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
180 (if (overlayp button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
181 (overlay-end button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
182 ;; Must be a text-property button.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
183 (or (next-single-property-change button 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
184 (point-max))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
185
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
186 (defun button-get (button prop)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
187 "Get the property of button BUTTON named PROP."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
188 (if (overlayp button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
189 (overlay-get button prop)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
190 ;; Must be a text-property button.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
191 (get-text-property button prop)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
192
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
193 (defun button-put (button prop val)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
194 "Set BUTTON's PROP property to VAL."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
195 ;; Treat some properties specially.
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
196 (cond ((memq prop '(type :type))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
197 ;; We translate a `type' property a `category' property, since
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
198 ;; that's what's actually used by overlays/text-properties for
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
199 ;; inheriting properties.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
200 (setq prop 'category)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
201 (setq val (button-category-symbol val)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
202 ((eq prop 'category)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
203 ;; Disallow updating the `category' property directly.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
204 (error "Button `category' property may not be set directly")))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
205 ;; Add the property.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
206 (if (overlayp button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
207 (overlay-put button prop val)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
208 ;; Must be a text-property button.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
209 (put-text-property
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
210 (or (previous-single-property-change (1+ button) 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
211 (point-min))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
212 (or (next-single-property-change button 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
213 (point-max))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
214 prop val)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
215
39676
9e8365caa0ee (button-activate): USE-MOUSE-ACTION is optional.
Miles Bader <miles@gnu.org>
parents: 39668
diff changeset
216 (defsubst button-activate (button &optional use-mouse-action)
39655
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
217 "Call BUTTON's action property.
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
218 If USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
219 instead of its normal action; if the button has no mouse-action,
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
220 the normal action is used instead."
57483
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
221 (let ((action (or (and use-mouse-action (button-get button 'mouse-action))
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
222 (button-get button 'action))))
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
223 (if (markerp action)
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
224 (save-selected-window
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
225 (select-window (display-buffer (marker-buffer action)))
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
226 (goto-char action)
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
227 (recenter 0))
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
228 (funcall action button))))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
229
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
230 (defun button-label (button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
231 "Return BUTTON's text label."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
232 (buffer-substring-no-properties (button-start button) (button-end button)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
233
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
234 (defsubst button-type (button)
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
235 "Return BUTTON's button-type."
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
236 (button-get button 'type))
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
237
39716
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
238 (defun button-has-type-p (button type)
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
239 "Return t if BUTTON has button-type TYPE, or one of TYPE's subtypes."
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
240 (button-type-subtype-p (button-get button 'type) type))
66d3b28583a0 (define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents: 39703
diff changeset
241
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
242
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
243 ;; Creating overlay buttons
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
244
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
245 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
246 (defun make-button (beg end &rest properties)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
247 "Make a button from BEG to END in the current buffer.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
248 The remaining arguments form a sequence of PROPERTY VALUE pairs,
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
249 specifying properties to add to the button.
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
250 In addition, the keyword argument :type may be used to specify a
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
251 button-type from which to inherit other properties; see
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
252 `define-button-type'.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
253
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
254 Also see `make-text-button', `insert-button'."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
255 (let ((overlay (make-overlay beg end nil t nil)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
256 (while properties
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
257 (button-put overlay (pop properties) (pop properties)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
258 ;; Put a pointer to the button in the overlay, so it's easy to get
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
259 ;; when we don't actually have a reference to the overlay.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
260 (overlay-put overlay 'button overlay)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
261 ;; If the user didn't specify a type, use the default.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
262 (unless (overlay-get overlay 'category)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
263 (overlay-put overlay 'category 'default-button))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
264 ;; OVERLAY is the button, so return it
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
265 overlay))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
266
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
267 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
268 (defun insert-button (label &rest properties)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
269 "Insert a button with the label LABEL.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
270 The remaining arguments form a sequence of PROPERTY VALUE pairs,
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
271 specifying properties to add to the button.
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
272 In addition, the keyword argument :type may be used to specify a
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
273 button-type from which to inherit other properties; see
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
274 `define-button-type'.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
275
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
276 Also see `insert-text-button', `make-button'."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
277 (apply #'make-button
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
278 (prog1 (point) (insert label))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
279 (point)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
280 properties))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
281
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
282
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
283 ;; Creating text-property buttons
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
284
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
285 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
286 (defun make-text-button (beg end &rest properties)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
287 "Make a button from BEG to END in the current buffer.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
288 The remaining arguments form a sequence of PROPERTY VALUE pairs,
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
289 specifying properties to add to the button.
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
290 In addition, the keyword argument :type may be used to specify a
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
291 button-type from which to inherit other properties; see
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
292 `define-button-type'.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
293
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
294 This function is like `make-button', except that the button is actually
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
295 part of the text instead of being a property of the buffer. Creating
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
296 large numbers of buttons can also be somewhat faster using
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
297 `make-text-button'.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
298
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
299 Also see `insert-text-button'."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
300 (let (prop val)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
301 (while properties
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
302 (setq prop (pop properties))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
303 (setq val (pop properties))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
304 ;; Note that all the following code is basically equivalent to
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
305 ;; `button-put', but we can do it much more efficiently since we
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
306 ;; already have BEG and END.
39916
5827976776b9 *** empty log message ***
Miles Bader <miles@gnu.org>
parents: 39716
diff changeset
307 (cond ((memq prop '(type :type))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
308 ;; We translate a `type' property into a `category'
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
309 ;; property, since that's what's actually used by
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
310 ;; text-properties for inheritance.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
311 (setq prop 'category)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
312 (setq val (button-category-symbol val)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
313 ((eq prop 'category)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
314 ;; Disallow setting the `category' property directly.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
315 (error "Button `category' property may not be set directly")))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
316 ;; Add the property.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
317 (put-text-property beg end prop val)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
318 ;; Return something that can be used to get at the button.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
319 beg)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
320
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
321 ;;;###autoload
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
322 (defun insert-text-button (label &rest properties)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
323 "Insert a button with the label LABEL.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
324 The remaining arguments form a sequence of PROPERTY VALUE pairs,
39917
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
325 specifying properties to add to the button.
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
326 In addition, the keyword argument :type may be used to specify a
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
327 button-type from which to inherit other properties; see
eb6a85173992 Doc fixes.
Miles Bader <miles@gnu.org>
parents: 39916
diff changeset
328 `define-button-type'.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
329
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
330 This function is like `insert-button', except that the button is
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
331 actually part of the text instead of being a property of the buffer.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
332 Creating large numbers of buttons can also be somewhat faster using
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
333 `insert-text-button'.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
334
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
335 Also see `make-text-button'."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
336 (apply #'make-text-button
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
337 (prog1 (point) (insert label))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
338 (point)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
339 properties))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
340
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
341
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
342 ;; Finding buttons in a buffer
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
343
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
344 (defun button-at (pos)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
345 "Return the button at position POS in the current buffer, or nil."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
346 (let ((button (get-char-property pos 'button)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
347 (if (or (overlayp button) (null button))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
348 button
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
349 ;; Must be a text-property button; return a marker pointing to it.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
350 (copy-marker pos t))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
351
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
352 (defun next-button (pos &optional count-current)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
353 "Return the next button after position POS in the current buffer.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
354 If COUNT-CURRENT is non-nil, count any button at POS in the search,
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
355 instead of starting at the next button."
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
356 (unless count-current
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
357 ;; Search for the next button boundary.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
358 (setq pos (next-single-char-property-change pos 'button)))
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
359 (and (< pos (point-max))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
360 (or (button-at pos)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
361 ;; We must have originally been on a button, and are now in
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
362 ;; the inter-button space. Recurse to find a button.
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
363 (next-button pos))))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
364
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
365 (defun previous-button (pos &optional count-current)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
366 "Return the Nth button before position POS in the current buffer.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
367 If COUNT-CURRENT is non-nil, count any button at POS in the search,
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
368 instead of starting at the next button."
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
369 (unless count-current
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
370 (setq pos (previous-single-char-property-change pos 'button)))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
371 (and (> pos (point-min))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
372 (or (button-at (1- pos))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
373 ;; We must have originally been on a button, and are now in
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
374 ;; the inter-button space. Recurse to find a button.
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
375 (previous-button pos))))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
376
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
377
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
378 ;; User commands
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
379
39655
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
380 (defun push-button (&optional pos use-mouse-action)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
381 "Perform the action specified by a button at location POS.
57483
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
382 POS may be either a buffer position or a mouse-event. If
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
383 USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action
39655
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
384 instead of its normal action; if the button has no mouse-action,
57483
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
385 the normal action is used instead. The action may be either a
12ad045f7911 (button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents: 52401
diff changeset
386 function to call or a marker to display.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
387 POS defaults to point, except when `push-button' is invoked
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
388 interactively as the result of a mouse-event, in which case, the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
389 mouse event is used.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
390 If there's no button at POS, do nothing and return nil, otherwise
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
391 return t."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
392 (interactive
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
393 (list (if (integerp last-command-event) (point) last-command-event)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
394 (if (and (not (integerp pos)) (eventp pos))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
395 ;; POS is a mouse event; switch to the proper window/buffer
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
396 (let ((posn (event-start pos)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
397 (with-current-buffer (window-buffer (posn-window posn))
39655
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
398 (push-button (posn-point posn) t)))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
399 ;; POS is just normal position
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
400 (let ((button (button-at (or pos (point)))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
401 (if (not button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
402 nil
39655
6aeeb8a310af (next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents: 39643
diff changeset
403 (button-activate button use-mouse-action)
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
404 t))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
405
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
406 (defun forward-button (n &optional wrap display-message)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
407 "Move to the Nth next button, or Nth previous button if N is negative.
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
408 If N is 0, move to the start of any button at point.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
409 If WRAP is non-nil, moving past either end of the buffer continues from the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
410 other end.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
411 If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed.
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
412 Any button with a non-nil `skip' property is skipped over.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
413 Returns the button found."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
414 (interactive "p\nd\nd")
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
415 (let (button)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
416 (if (zerop n)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
417 ;; Move to start of current button
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
418 (if (setq button (button-at (point)))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
419 (goto-char (button-start button)))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
420 ;; Move to Nth next button
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
421 (let ((iterator (if (> n 0) #'next-button #'previous-button))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
422 (wrap-start (if (> n 0) (point-min) (point-max))))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
423 (setq n (abs n))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
424 (setq button t) ; just to start the loop
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
425 (while (and (> n 0) button)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
426 (setq button (funcall iterator (point)))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
427 (when (and (not button) wrap)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
428 (setq button (funcall iterator wrap-start t)))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
429 (when button
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
430 (goto-char (button-start button))
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
431 (unless (button-get button 'skip)
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
432 (setq n (1- n)))))))
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
433 (if (null button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
434 (error (if wrap "No buttons!" "No more buttons"))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
435 (let ((msg (and display-message (button-get button 'help-echo))))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
436 (when msg
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
437 (message "%s" msg)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
438 button)))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
439
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
440 (defun backward-button (n &optional wrap display-message)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
441 "Move to the Nth previous button, or Nth next button if N is negative.
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
442 If N is 0, move to the start of any button at point.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
443 If WRAP is non-nil, moving past either end of the buffer continues from the
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
444 other end.
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
445 If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed.
39668
1666965880cc (next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents: 39655
diff changeset
446 Any button with a non-nil `skip' property is skipped over.
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
447 Returns the button found."
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
448 (interactive "p\nd\nd")
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
449 (forward-button (- n) wrap display-message))
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
450
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
451
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
452 (provide 'button)
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
453
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49001
diff changeset
454 ;;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
39643
3159dbc2f268 Initial checkin.
Miles Bader <miles@gnu.org>
parents:
diff changeset
455 ;;; button.el ends here