Mercurial > emacs
annotate lisp/tooltip.el @ 59313:ad91f130fbdf
(vc-arch-workfile-version): Fix last change.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Sun, 02 Jan 2005 22:07:52 +0000 |
parents | 3d934eda2724 |
children | 3af3548ad26d eac554634bfa |
rev | line source |
---|---|
45236 | 1 ;;; tooltip.el --- show tooltip windows |
25003 | 2 |
59017
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004 |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
4 ;; Free Software Foundation, Inc. |
25003 | 5 |
6 ;; Author: Gerd Moellmann <gerd@acm.org> | |
7 ;; Keywords: help c mouse tools | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
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. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
25 | |
26 ;;; Commentary: | |
27 | |
28 ;;; Code: | |
29 | |
58163
7048d946d9df
(require): Explain why CL is needed.
Nick Roberts <nickrob@snap.net.nz>
parents:
58155
diff
changeset
|
30 (eval-when-compile (require 'cl)) ; for case macro |
58155 | 31 |
25003 | 32 |
33 ;;; Customizable settings | |
34 | |
35 (defgroup tooltip nil | |
36 "Customization group for the `tooltip' package." | |
37 :group 'help | |
37755
cf803b8f08ad
(tooltip) <defgroup>: Put it in `gud' group instead
Gerd Moellmann <gerd@gnu.org>
parents:
35401
diff
changeset
|
38 :group 'gud |
25003 | 39 :group 'mouse |
40 :group 'tools | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
41 :version "21.1" |
25003 | 42 :tag "Tool Tips") |
43 | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
44 (defvar tooltip-mode) |
25003 | 45 |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
46 (defcustom tooltip-delay 0.7 |
25003 | 47 "Seconds to wait before displaying a tooltip the first time." |
48 :tag "Delay" | |
49 :type 'number | |
50 :group 'tooltip) | |
51 | |
52 (defcustom tooltip-short-delay 0.1 | |
53 "Seconds to wait between subsequent tooltips on different items." | |
54 :tag "Short delay" | |
55 :type 'number | |
56 :group 'tooltip) | |
57 | |
58 (defcustom tooltip-recent-seconds 1 | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
59 "Display tooltips if changing tip items within this many seconds. |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
60 Do so after `tooltip-short-delay'." |
25003 | 61 :tag "Recent seconds" |
62 :type 'number | |
63 :group 'tooltip) | |
64 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
65 (defcustom tooltip-hide-delay 10 |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
66 "Hide tooltips automatically after this many seconds." |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
67 :tag "Hide delay" |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
68 :type 'number |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
69 :group 'tooltip) |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
70 |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
71 (defcustom tooltip-x-offset nil |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
72 "X offset, in pixels, for the display of tooltips. |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
73 The offset is relative to the position of the mouse. It must |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
74 be chosen so that the tooltip window doesn't contain the mouse |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
75 when it pops up. If the value is nil, the default offset is 5 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
76 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
77 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
78 If `tooltip-frame-parameters' includes the `left' parameter, |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
79 the value of `tooltip-x-offset' is ignored." |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
80 :tag "X offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
81 :type '(choice (const :tag "Default" nil) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
82 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
83 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
84 |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
85 (defcustom tooltip-y-offset nil |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
86 "Y offset, in pixels, for the display of tooltips. |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
87 The offset is relative to the position of the mouse. It must |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
88 be chosen so that the tooltip window doesn't contain the mouse |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
89 when it pops up. If the value is nil, the default offset is -10 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
90 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
91 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
92 If `tooltip-frame-parameters' includes the `top' parameter, |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
93 the value of `tooltip-y-offset' is ignored." |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
94 :tag "Y offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
95 :type '(choice (const :tag "Default" nil) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
96 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
97 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
98 |
25003 | 99 (defcustom tooltip-frame-parameters |
100 '((name . "tooltip") | |
101 (internal-border-width . 5) | |
102 (border-width . 1)) | |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
103 "Frame parameters used for tooltips. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
104 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
105 If `left' or `top' parameters are included, they specify the absolute |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
106 position to pop up the tooltip." |
25003 | 107 :type 'sexp |
108 :tag "Frame Parameters" | |
109 :group 'tooltip) | |
110 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
111 (defface tooltip |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
112 '((((class color)) |
52031
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
113 :background "lightyellow" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
114 :foreground "black" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
115 :inherit variable-pitch) |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
116 (t |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
117 :inherit variable-pitch)) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
118 "Face for tooltips." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
119 :group 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
120 |
25003 | 121 (defcustom tooltip-gud-tips-p nil |
48651
572f41d9a2ea
(tooltip-gud-tips-p): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents:
48601
diff
changeset
|
122 "*Non-nil means show tooltips in GUD sessions." |
25003 | 123 :type 'boolean |
124 :tag "GUD" | |
33140
61f4c87b845c
(tooltip-gud-tips-setup): New function.
Miles Bader <miles@gnu.org>
parents:
32431
diff
changeset
|
125 :set #'(lambda (symbol on) |
48572
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
126 (setq tooltip-gud-tips-p on)) |
25003 | 127 :group 'tooltip) |
128 | |
129 (defcustom tooltip-gud-modes '(gud-mode c-mode c++-mode) | |
130 "List of modes for which to enable GUD tips." | |
131 :type 'sexp | |
132 :tag "GUD modes" | |
133 :group 'tooltip) | |
134 | |
135 (defcustom tooltip-gud-display | |
136 '((eq (tooltip-event-buffer tooltip-gud-event) | |
137 (marker-buffer overlay-arrow-position))) | |
138 "List of forms determining where GUD tooltips are displayed. | |
139 | |
140 Forms in the list are combined with AND. The default is to display | |
141 only tooltips in the buffer containing the overlay arrow." | |
142 :type 'sexp | |
143 :tag "GUD buffers predicate" | |
144 :group 'tooltip) | |
145 | |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
146 (defcustom tooltip-use-echo-area nil |
33923 | 147 "Use the echo area instead of tooltip frames. |
148 This is only relevant GUD display, since otherwise it is equivalent to | |
149 turning off Tooltip mode." | |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
150 :type 'boolean |
33925 | 151 :tag "Use echo area" |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
152 :group 'tooltip) |
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
153 |
25003 | 154 |
155 ;;; Variables that are not customizable. | |
156 | |
157 (defvar tooltip-hook nil | |
158 "Functions to call to display tooltips. | |
159 Each function is called with one argument EVENT which is a copy of | |
160 the last mouse movement event that occurred.") | |
161 | |
162 (defvar tooltip-timeout-id nil | |
163 "The id of the timeout started when Emacs becomes idle.") | |
164 | |
165 (defvar tooltip-last-mouse-motion-event nil | |
166 "A copy of the last mouse motion event seen.") | |
167 | |
168 (defvar tooltip-hide-time nil | |
169 "Time when the last tooltip was hidden.") | |
170 | |
171 | |
172 ;;; Event accessors | |
173 | |
174 (defun tooltip-event-buffer (event) | |
175 "Return the buffer over which event EVENT occurred. | |
176 This might return nil if the event did not occur over a buffer." | |
177 (let ((window (posn-window (event-end event)))) | |
178 (and window (window-buffer window)))) | |
179 | |
180 | |
181 ;;; Switching tooltips on/off | |
182 | |
183 ;; We don't set track-mouse globally because this is a big redisplay | |
184 ;; problem in buffers having a pre-command-hook or such installed, | |
185 ;; which does a set-buffer, like the summary buffer of Gnus. Calling | |
186 ;; set-buffer prevents redisplay optimizations, so every mouse motion | |
187 ;; would be accompanied by a full redisplay. | |
188 | |
189 ;;;###autoload | |
190 (defun tooltip-mode (&optional arg) | |
191 "Mode for tooltip display. | |
192 With ARG, turn tooltip mode on if and only if ARG is positive." | |
193 (interactive "P") | |
34689
e045e0e60223
(tooltip-mode): Signal an error if x-show-tip
Gerd Moellmann <gerd@gnu.org>
parents:
34540
diff
changeset
|
194 (unless (fboundp 'x-show-tip) |
e045e0e60223
(tooltip-mode): Signal an error if x-show-tip
Gerd Moellmann <gerd@gnu.org>
parents:
34540
diff
changeset
|
195 (error "Sorry, tooltips are not yet available on this system")) |
25003 | 196 (let* ((on (if arg |
197 (> (prefix-numeric-value arg) 0) | |
198 (not tooltip-mode))) | |
199 (hook-fn (if on 'add-hook 'remove-hook))) | |
200 (setq tooltip-mode on) | |
201 (funcall hook-fn 'change-major-mode-hook 'tooltip-change-major-mode) | |
202 (tooltip-activate-mouse-motions-if-enabled) | |
203 (funcall hook-fn 'pre-command-hook 'tooltip-hide) | |
204 (funcall hook-fn 'tooltip-hook 'tooltip-gud-tips) | |
205 (funcall hook-fn 'tooltip-hook 'tooltip-help-tips) | |
206 (setq show-help-function (if on 'tooltip-show-help-function nil)) | |
207 ;; `ignore' is the default binding for mouse movements. | |
208 (define-key global-map [mouse-movement] | |
48572
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
209 (if on 'tooltip-mouse-motion 'ignore)))) |
25003 | 210 |
211 | |
212 ;;; Timeout for tooltip display | |
213 | |
214 (defun tooltip-delay () | |
215 "Return the delay in seconds for the next tooltip." | |
216 (let ((delay tooltip-delay) | |
30481 | 217 (now (float-time))) |
25003 | 218 (when (and tooltip-hide-time |
219 (< (- now tooltip-hide-time) tooltip-recent-seconds)) | |
220 (setq delay tooltip-short-delay)) | |
221 delay)) | |
222 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
223 (defun tooltip-cancel-delayed-tip () |
25003 | 224 "Disable the tooltip timeout." |
225 (when tooltip-timeout-id | |
226 (disable-timeout tooltip-timeout-id) | |
227 (setq tooltip-timeout-id nil))) | |
228 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
229 (defun tooltip-start-delayed-tip () |
25003 | 230 "Add a one-shot timeout to call function tooltip-timeout." |
231 (setq tooltip-timeout-id | |
232 (add-timeout (tooltip-delay) 'tooltip-timeout nil))) | |
233 | |
234 (defun tooltip-timeout (object) | |
235 "Function called when timer with id tooltip-timeout-id fires." | |
236 (run-hook-with-args-until-success 'tooltip-hook | |
237 tooltip-last-mouse-motion-event)) | |
238 | |
239 | |
240 ;;; Reacting on mouse movements | |
241 | |
242 (defun tooltip-change-major-mode () | |
243 "Function added to `change-major-mode-hook' when tooltip mode is on." | |
244 (add-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled)) | |
245 | |
246 (defun tooltip-activate-mouse-motions-if-enabled () | |
247 "Reconsider for all buffers whether mouse motion events are desired." | |
248 (remove-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled) | |
249 (let ((buffers (buffer-list))) | |
250 (save-excursion | |
251 (while buffers | |
252 (set-buffer (car buffers)) | |
253 (if (and tooltip-mode | |
254 tooltip-gud-tips-p | |
255 (memq major-mode tooltip-gud-modes)) | |
256 (tooltip-activate-mouse-motions t) | |
257 (tooltip-activate-mouse-motions nil)) | |
258 (setq buffers (cdr buffers)))))) | |
259 | |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
260 (defvar tooltip-mouse-motions-active nil |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
261 "Locally t in a buffer if tooltip processing of mouse motion is enabled.") |
25003 | 262 |
263 (defun tooltip-activate-mouse-motions (activatep) | |
264 "Activate/deactivate mouse motion events for the current buffer. | |
265 ACTIVATEP non-nil means activate mouse motion events." | |
266 (if activatep | |
267 (progn | |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
268 (make-local-variable 'tooltip-mouse-motions-active) |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
269 (setq tooltip-mouse-motions-active t) |
25003 | 270 (make-local-variable 'track-mouse) |
271 (setq track-mouse t)) | |
45571
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
272 (when tooltip-mouse-motions-active |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
273 (kill-local-variable 'tooltip-mouse-motions-active) |
04484b8dacdc
(tooltip-mouse-motions-active): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
45236
diff
changeset
|
274 (kill-local-variable 'track-mouse)))) |
25003 | 275 |
276 (defun tooltip-mouse-motion (event) | |
277 "Command handler for mouse movement events in `global-map'." | |
278 (interactive "e") | |
279 (tooltip-hide) | |
280 (when (car (mouse-pixel-position)) | |
281 (setq tooltip-last-mouse-motion-event (copy-sequence event)) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
282 (tooltip-start-delayed-tip))) |
25003 | 283 |
284 | |
285 ;;; Displaying tips | |
286 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
287 (defun tooltip-set-param (alist key value) |
40178
1dab42ecd751
(tooltip-set-param): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
40173
diff
changeset
|
288 "Change the value of KEY in alist ALIST to VALUE. |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
289 If there's no association for KEY in ALIST, add one, otherwise |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
290 change the existing association. Value is the resulting alist." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
291 (let ((param (assq key alist))) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
292 (if (consp param) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
293 (setcdr param value) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
294 (push (cons key value) alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
295 alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
296 |
25003 | 297 (defun tooltip-show (text) |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
298 "Show a tooltip window displaying TEXT. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
299 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
300 Text larger than `x-max-tooltip-size' (which see) is clipped. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
301 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
302 If the alist in `tooltip-frame-parameters' includes `left' and `top' |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
303 parameters, they determine the x and y position where the tooltip |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
304 is displayed. Otherwise, the tooltip pops at offsets specified by |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
305 `tooltip-x-offset' and `tooltip-y-offset' from the current mouse |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
306 position." |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
307 (if tooltip-use-echo-area |
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
308 (message "%s" text) |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
309 (condition-case error |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
310 (let ((params (copy-sequence tooltip-frame-parameters)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
311 (fg (face-attribute 'tooltip :foreground)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
312 (bg (face-attribute 'tooltip :background))) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
313 (when (stringp fg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
314 (setq params (tooltip-set-param params 'foreground-color fg)) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
315 (setq params (tooltip-set-param params 'border-color fg))) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
316 (when (stringp bg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
317 (setq params (tooltip-set-param params 'background-color bg))) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
318 (x-show-tip (propertize text 'face 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
319 (selected-frame) |
35044 | 320 params |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
321 tooltip-hide-delay |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
322 tooltip-x-offset |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
323 tooltip-y-offset)) |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
324 (error |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
325 (message "Error while displaying tooltip: %s" error) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
326 (sit-for 1) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
327 (message "%s" text))))) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
328 |
25003 | 329 (defun tooltip-hide (&optional ignored-arg) |
330 "Hide a tooltip, if one is displayed. | |
331 Value is non-nil if tooltip was open." | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
332 (tooltip-cancel-delayed-tip) |
25003 | 333 (when (x-hide-tip) |
30481 | 334 (setq tooltip-hide-time (float-time)))) |
25003 | 335 |
336 | |
337 ;;; Debugger-related functions | |
338 | |
339 (defun tooltip-identifier-from-point (point) | |
340 "Extract the identifier at POINT, if any. | |
341 Value is nil if no identifier exists at point. Identifier extraction | |
342 is based on the current syntax table." | |
343 (save-excursion | |
344 (goto-char point) | |
345 (let ((start (progn (skip-syntax-backward "w_") (point)))) | |
346 (unless (looking-at "[0-9]") | |
347 (skip-syntax-forward "w_") | |
348 (when (> (point) start) | |
349 (buffer-substring start (point))))))) | |
350 | |
351 (defmacro tooltip-region-active-p () | |
352 "Value is non-nil if the region is currently active." | |
353 (if (string-match "^GNU" (emacs-version)) | |
354 `(and transient-mark-mode mark-active) | |
355 `(region-active-p))) | |
356 | |
357 (defun tooltip-expr-to-print (event) | |
358 "Return an expression that should be printed for EVENT. | |
359 If a region is active and the mouse is inside the region, print | |
360 the region. Otherwise, figure out the identifier around the point | |
361 where the mouse is." | |
362 (save-excursion | |
363 (set-buffer (tooltip-event-buffer event)) | |
364 (let ((point (posn-point (event-end event)))) | |
365 (if (tooltip-region-active-p) | |
366 (when (and (<= (region-beginning) point) (<= point (region-end))) | |
367 (buffer-substring (region-beginning) (region-end))) | |
368 (tooltip-identifier-from-point point))))) | |
369 | |
370 (defun tooltip-process-prompt-regexp (process) | |
371 "Return regexp matching the prompt of PROCESS at the end of a string. | |
372 The prompt is taken from the value of COMINT-PROMPT-REGEXP in the buffer | |
373 of PROCESS." | |
374 (let ((prompt-regexp (save-excursion | |
375 (set-buffer (process-buffer process)) | |
376 comint-prompt-regexp))) | |
377 ;; Most start with `^' but the one for `sdb' cannot be easily | |
378 ;; stripped. Code the prompt for `sdb' fixed here. | |
379 (if (= (aref prompt-regexp 0) ?^) | |
380 (setq prompt-regexp (substring prompt-regexp 1)) | |
381 (setq prompt-regexp "\\*")) | |
382 (concat "\n*" prompt-regexp "$"))) | |
383 | |
384 (defun tooltip-strip-prompt (process output) | |
385 "Return OUTPUT with any prompt of PROCESS stripped from its end." | |
386 (let ((prompt-regexp (tooltip-process-prompt-regexp process))) | |
387 (save-match-data | |
388 (when (string-match prompt-regexp output) | |
389 (setq output (substring output 0 (match-beginning 0))))) | |
390 output)) | |
391 | |
392 | |
393 ;;; Tips for `gud' | |
394 | |
395 (defvar tooltip-gud-original-filter nil | |
396 "Process filter to restore after GUD output has been received.") | |
397 | |
398 (defvar tooltip-gud-dereference nil | |
399 "Non-nil means print expressions with a `*' in front of them. | |
400 For C this would dereference a pointer expression.") | |
401 | |
402 (defvar tooltip-gud-event nil | |
403 "The mouse movement event that led to a tooltip display. | |
404 This event can be examined by forms in TOOLTIP-GUD-DISPLAY.") | |
405 | |
406 (defun tooltip-gud-toggle-dereference () | |
27582
42b52d8b6703
(tooltip-gud-tips-p, tooltip-gud-toggle-dereference):
Dave Love <fx@gnu.org>
parents:
25332
diff
changeset
|
407 "Toggle whether tooltips should show `* expr' or `expr'." |
25003 | 408 (interactive) |
409 (setq tooltip-gud-dereference (not tooltip-gud-dereference)) | |
410 (when (interactive-p) | |
411 (message "Dereferencing is now %s." | |
412 (if tooltip-gud-dereference "on" "off")))) | |
413 | |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
414 ; This will only display data that comes in one chunk. |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
415 ; Larger arrays (say 400 elements) are displayed in |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
416 ; the tootip incompletely and spill over into the gud buffer. |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
417 ; Switching the process-filter creates timing problems and |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
418 ; it may be difficult to do better. gdba in gdb-ui.el |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
419 ; gets round this problem. |
25003 | 420 (defun tooltip-gud-process-output (process output) |
421 "Process debugger output and show it in a tooltip window." | |
422 (set-process-filter process tooltip-gud-original-filter) | |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
423 (tooltip-show (tooltip-strip-prompt process output))) |
25003 | 424 |
425 (defun tooltip-gud-print-command (expr) | |
426 "Return a suitable command to print the expression EXPR. | |
427 If TOOLTIP-GUD-DEREFERENCE is t, also prepend a `*' to EXPR." | |
428 (when tooltip-gud-dereference | |
429 (setq expr (concat "*" expr))) | |
48572
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
430 (case gud-minor-mode |
67d16fb6f6c8
(tooltip-gud-tips-setup): Remove.
Nick Roberts <nickrob@snap.net.nz>
parents:
48517
diff
changeset
|
431 ((gdb gdba) (concat "server print " expr)) |
48517
2941d71711f3
(tooltip-gud-print-command): Add server prefix to the
Nick Roberts <nickrob@snap.net.nz>
parents:
46025
diff
changeset
|
432 (dbx (concat "print " expr)) |
25003 | 433 (xdb (concat "p " expr)) |
434 (sdb (concat expr "/")) | |
435 (perldb expr))) | |
30481 | 436 |
25003 | 437 (defun tooltip-gud-tips (event) |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
438 "Show tip for identifier or selection under the mouse. |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
439 The mouse must either point at an identifier or inside a selected |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
440 region for the tip window to be shown. If tooltip-gud-dereference is t, |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
441 add a `*' in front of the printed expression. |
25003 | 442 |
443 This function must return nil if it doesn't handle EVENT." | |
444 (let (gud-buffer process) | |
445 (when (and (eventp event) | |
446 tooltip-gud-tips-p | |
447 (boundp 'gud-comint-buffer) | |
448 (setq gud-buffer gud-comint-buffer) | |
449 (setq process (get-buffer-process gud-buffer)) | |
450 (posn-point (event-end event)) | |
451 (progn (setq tooltip-gud-event event) | |
452 (eval (cons 'and tooltip-gud-display)))) | |
453 (let ((expr (tooltip-expr-to-print event))) | |
454 (when expr | |
33140
61f4c87b845c
(tooltip-gud-tips-setup): New function.
Miles Bader <miles@gnu.org>
parents:
32431
diff
changeset
|
455 (let ((cmd (tooltip-gud-print-command expr))) |
61f4c87b845c
(tooltip-gud-tips-setup): New function.
Miles Bader <miles@gnu.org>
parents:
32431
diff
changeset
|
456 (unless (null cmd) ; CMD can be nil if unknown debugger |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
457 (case gud-minor-mode |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
458 (gdba (gdb-enqueue-input |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
459 (list (concat cmd "\n") 'gdb-tooltip-print))) |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
460 (t |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
461 (setq tooltip-gud-original-filter (process-filter process)) |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
462 (set-process-filter process 'tooltip-gud-process-output) |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
463 (gud-basic-call cmd))) |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
464 expr))))))) |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
465 |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
466 (defun gdb-tooltip-print () |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
467 (tooltip-show |
48925
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
468 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer) |
cd1c70649388
(tooltip-gud-tips): Output tooltip without switching
Nick Roberts <nickrob@snap.net.nz>
parents:
48651
diff
changeset
|
469 (buffer-string)))) |
25003 | 470 |
471 | |
472 ;;; Tooltip help. | |
473 | |
474 (defvar tooltip-help-message nil | |
475 "The last help message received via `tooltip-show-help-function'.") | |
476 | |
477 (defun tooltip-show-help-function (msg) | |
478 "Function installed as `show-help-function'. | |
479 MSG is either a help string to display, or nil to cancel the display." | |
59017
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
480 (let ((previous-help tooltip-help-message) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
481 mp pos) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
482 (if (and mouse-1-click-follows-link |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
483 (stringp msg) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
484 (save-match-data |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
485 (string-match "^mouse-2" msg)) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
486 (setq mp (mouse-pixel-position)) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
487 (consp (setq pos (cdr mp))) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
488 (setq pos (posn-at-x-y (car pos) (cdr pos) (car mp))) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
489 (windowp (posn-window pos))) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
490 (with-current-buffer (window-buffer (posn-window pos)) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
491 (if (mouse-on-link-p (posn-point pos)) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
492 (setq msg (concat |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
493 (cond |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
494 ((eq mouse-1-click-follows-link 'double) "double-") |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
495 ((and (integerp mouse-1-click-follows-link) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
496 (< mouse-1-click-follows-link 0)) "Long ") |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
497 (t "")) |
3d934eda2724
(tooltip-show-help-function): Replace "mouse-2"
Kim F. Storm <storm@cua.dk>
parents:
58488
diff
changeset
|
498 "mouse-1" (substring msg 7)))))) |
25003 | 499 (setq tooltip-help-message msg) |
500 (cond ((null msg) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
501 ;; Cancel display. This also cancels a delayed tip, if |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
502 ;; there is one. |
25003 | 503 (tooltip-hide)) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
504 ((equal previous-help msg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
505 ;; Same help as before (but possibly the mouse has moved). |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
506 ;; Keep what we have. |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
507 ) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
508 (t |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
509 ;; A different help. Remove a previous tooltip, and |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
510 ;; display a new one, with some delay. |
25003 | 511 (tooltip-hide) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
512 (tooltip-start-delayed-tip))))) |
25003 | 513 |
514 (defun tooltip-help-tips (event) | |
515 "Hook function to display a help tooltip. | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
516 This is installed on the hook `tooltip-hook', which is run when |
42706 | 517 the timer with ID `tooltip-timeout-id' fires. |
25003 | 518 Value is non-nil if this function handled the tip." |
519 (when (stringp tooltip-help-message) | |
520 (tooltip-show tooltip-help-message) | |
521 t)) | |
522 | |
523 | |
33356
73a360d50e18
(tooltip-mode): Add a comment about startup.el
Gerd Moellmann <gerd@gnu.org>
parents:
33140
diff
changeset
|
524 ;;; Do this after all functions have been defined that are called from |
73a360d50e18
(tooltip-mode): Add a comment about startup.el
Gerd Moellmann <gerd@gnu.org>
parents:
33140
diff
changeset
|
525 ;;; `tooltip-mode'. The actual default value of `tooltip-mode' is set |
73a360d50e18
(tooltip-mode): Add a comment about startup.el
Gerd Moellmann <gerd@gnu.org>
parents:
33140
diff
changeset
|
526 ;;; in startup.el. |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
527 |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
528 ;;;###autoload |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
529 (defcustom tooltip-mode nil |
58488
02e7f3437fea
(tooltip-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
58163
diff
changeset
|
530 "Non-nil if Tooltip mode is enabled. |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
531 Setting this variable directly does not take effect; |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
532 use either \\[customize] or the function `tooltip-mode'." |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
533 :set (lambda (symbol value) |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
534 (tooltip-mode (or value 0))) |
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
535 :initialize 'custom-initialize-default |
25003 | 536 :type 'boolean |
537 :require 'tooltip | |
538 :group 'tooltip) | |
539 | |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
540 (provide 'tooltip) |
25003 | 541 |
58155 | 542 ;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f |
25003 | 543 ;;; tooltip.el ends here |