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