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