Mercurial > emacs
annotate lisp/tooltip.el @ 63888:ccf4a0e5ff34
*** empty log message ***
author | Andreas Schwab <schwab@suse.de> |
---|---|
date | Thu, 30 Jun 2005 21:10:27 +0000 |
parents | b02ea134efad |
children | cd982981d99a b7da78284d4c |
rev | line source |
---|---|
45236 | 1 ;;; tooltip.el --- show tooltip windows |
25003 | 2 |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005 |
59017
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 | |
30 ;;; Customizable settings | |
31 | |
32 (defgroup tooltip nil | |
33 "Customization group for the `tooltip' package." | |
34 :group 'help | |
37755
cf803b8f08ad
(tooltip) <defgroup>: Put it in `gud' group instead
Gerd Moellmann <gerd@gnu.org>
parents:
35401
diff
changeset
|
35 :group 'gud |
25003 | 36 :group 'mouse |
37 :group 'tools | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
38 :version "21.1" |
25003 | 39 :tag "Tool Tips") |
40 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
41 (defcustom tooltip-delay 0.7 |
25003 | 42 "Seconds to wait before displaying a tooltip the first time." |
43 :tag "Delay" | |
44 :type 'number | |
45 :group 'tooltip) | |
46 | |
47 (defcustom tooltip-short-delay 0.1 | |
48 "Seconds to wait between subsequent tooltips on different items." | |
49 :tag "Short delay" | |
50 :type 'number | |
51 :group 'tooltip) | |
52 | |
53 (defcustom tooltip-recent-seconds 1 | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
54 "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
|
55 Do so after `tooltip-short-delay'." |
25003 | 56 :tag "Recent seconds" |
57 :type 'number | |
58 :group 'tooltip) | |
59 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
60 (defcustom tooltip-hide-delay 10 |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
61 "Hide tooltips automatically after this many seconds." |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
62 :tag "Hide delay" |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
63 :type 'number |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
64 :group 'tooltip) |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
65 |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
66 (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
|
67 "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
|
68 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
|
69 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
|
70 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
|
71 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
72 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
73 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
|
74 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
|
75 :tag "X offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
76 :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
|
77 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
78 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
79 |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
80 (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
|
81 "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
|
82 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
|
83 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
|
84 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
|
85 pixels. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
86 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
87 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
|
88 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
|
89 :tag "Y offset" |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
90 :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
|
91 (integer :tag "Offset" :value 1)) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
92 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
93 |
25003 | 94 (defcustom tooltip-frame-parameters |
95 '((name . "tooltip") | |
96 (internal-border-width . 5) | |
97 (border-width . 1)) | |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
98 "Frame parameters used for tooltips. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
99 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
100 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
|
101 position to pop up the tooltip." |
25003 | 102 :type 'sexp |
103 :tag "Frame Parameters" | |
104 :group 'tooltip) | |
105 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
106 (defface tooltip |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
107 '((((class color)) |
52031
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
108 :background "lightyellow" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
109 :foreground "black" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
110 :inherit variable-pitch) |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
111 (t |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
112 :inherit variable-pitch)) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
113 "Face for tooltips." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
114 :group 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
115 |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
116 (defcustom tooltip-use-echo-area nil |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
117 "Use the echo area instead of tooltip frames for help and GUD tooltips." |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
118 :type 'boolean |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
119 :tag "Use echo area" |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
120 :group 'tooltip) |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
121 |
25003 | 122 |
123 ;;; Variables that are not customizable. | |
124 | |
125 (defvar tooltip-hook nil | |
126 "Functions to call to display tooltips. | |
127 Each function is called with one argument EVENT which is a copy of | |
128 the last mouse movement event that occurred.") | |
129 | |
130 (defvar tooltip-timeout-id nil | |
131 "The id of the timeout started when Emacs becomes idle.") | |
132 | |
133 (defvar tooltip-last-mouse-motion-event nil | |
134 "A copy of the last mouse motion event seen.") | |
135 | |
136 (defvar tooltip-hide-time nil | |
137 "Time when the last tooltip was hidden.") | |
138 | |
139 ;;; Event accessors | |
140 | |
141 (defun tooltip-event-buffer (event) | |
142 "Return the buffer over which event EVENT occurred. | |
143 This might return nil if the event did not occur over a buffer." | |
144 (let ((window (posn-window (event-end event)))) | |
145 (and window (window-buffer window)))) | |
146 | |
147 ;;; Switching tooltips on/off | |
148 | |
149 ;; We don't set track-mouse globally because this is a big redisplay | |
150 ;; problem in buffers having a pre-command-hook or such installed, | |
151 ;; which does a set-buffer, like the summary buffer of Gnus. Calling | |
152 ;; set-buffer prevents redisplay optimizations, so every mouse motion | |
153 ;; would be accompanied by a full redisplay. | |
154 | |
155 ;;;###autoload | |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
156 (define-minor-mode tooltip-mode |
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
157 "Toggle Tooltip display. |
25003 | 158 With ARG, turn tooltip mode on if and only if ARG is positive." |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
159 :global t |
61565
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
160 ;; If you change the :init-value below, you also need to change the |
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
161 ;; corresponding code in startup.el. |
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
162 :init-value (not (or noninteractive |
61614
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
163 (and (boundp 'emacs-quick-startup) emacs-quick-startup) |
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
164 (not (and (fboundp 'display-graphic-p) |
5739226d2d8c
(tooltip-mode): `emacs-quick-startup' and `display-graphic-p' may not
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
61608
diff
changeset
|
165 (display-graphic-p))) |
61565
19480ce3528d
(tooltip-mode): Specify correct standard value for Custom in init-value.
Luc Teirlinck <teirllm@auburn.edu>
parents:
61161
diff
changeset
|
166 (not (fboundp 'x-show-tip)))) |
60539
60737ce5edc8
(tooltip-mode): Use define-minor-mode and simplify.
Nick Roberts <nickrob@snap.net.nz>
parents:
60205
diff
changeset
|
167 :group 'tooltip |
60547
23b4e52963d6
(tooltip-mode): Don't complain that you can't turn the
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
60539
diff
changeset
|
168 (unless (or (null tooltip-mode) (fboundp 'x-show-tip)) |
34689
e045e0e60223
(tooltip-mode): Signal an error if x-show-tip
Gerd Moellmann <gerd@gnu.org>
parents:
34540
diff
changeset
|
169 (error "Sorry, tooltips are not yet available on this system")) |
62135
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
170 (if tooltip-mode |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
171 (progn |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
172 (add-hook 'pre-command-hook 'tooltip-hide) |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
173 (add-hook 'tooltip-hook 'tooltip-help-tips)) |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
174 (unless (and (boundp 'gud-tooltip-mode) gud-tooltip-mode) |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
175 (remove-hook 'pre-command-hook 'tooltip-hide)) |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
176 (remove-hook 'tooltip-hook 'tooltip-help-tips)) |
70a3dba2b7ea
(require): CL no longer needed to compile case.
Nick Roberts <nickrob@snap.net.nz>
parents:
62048
diff
changeset
|
177 (setq show-help-function |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
178 (if tooltip-mode 'tooltip-show-help nil))) |
25003 | 179 |
180 | |
181 ;;; Timeout for tooltip display | |
182 | |
183 (defun tooltip-delay () | |
184 "Return the delay in seconds for the next tooltip." | |
185 (let ((delay tooltip-delay) | |
30481 | 186 (now (float-time))) |
25003 | 187 (when (and tooltip-hide-time |
188 (< (- now tooltip-hide-time) tooltip-recent-seconds)) | |
189 (setq delay tooltip-short-delay)) | |
190 delay)) | |
191 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
192 (defun tooltip-cancel-delayed-tip () |
25003 | 193 "Disable the tooltip timeout." |
194 (when tooltip-timeout-id | |
195 (disable-timeout tooltip-timeout-id) | |
196 (setq tooltip-timeout-id nil))) | |
197 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
198 (defun tooltip-start-delayed-tip () |
63483
8e09dea7559c
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
Juanma Barranquero <lekktu@gmail.com>
parents:
63441
diff
changeset
|
199 "Add a one-shot timeout to call function `tooltip-timeout'." |
25003 | 200 (setq tooltip-timeout-id |
201 (add-timeout (tooltip-delay) 'tooltip-timeout nil))) | |
202 | |
203 (defun tooltip-timeout (object) | |
63483
8e09dea7559c
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
Juanma Barranquero <lekktu@gmail.com>
parents:
63441
diff
changeset
|
204 "Function called when timer with id `tooltip-timeout-id' fires." |
25003 | 205 (run-hook-with-args-until-success 'tooltip-hook |
206 tooltip-last-mouse-motion-event)) | |
207 | |
208 | |
209 ;;; Displaying tips | |
210 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
211 (defun tooltip-set-param (alist key value) |
40178
1dab42ecd751
(tooltip-set-param): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
40173
diff
changeset
|
212 "Change the value of KEY in alist ALIST to VALUE. |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
213 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
|
214 change the existing association. Value is the resulting alist." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
215 (let ((param (assq key alist))) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
216 (if (consp param) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
217 (setcdr param value) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
218 (push (cons key value) alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
219 alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
220 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
221 (defun tooltip-show (text &optional use-echo-area) |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
222 "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
|
223 |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
224 Text larger than `x-max-tooltip-size' is clipped. |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
225 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
226 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
|
227 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
|
228 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
|
229 `tooltip-x-offset' and `tooltip-y-offset' from the current mouse |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
230 position. |
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
231 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
232 Optional second arg USE-ECHO-AREA non-nil means to show tooltip |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
233 in echo area." |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
234 (if use-echo-area |
32431
a35cc9700ff7
* tooltip.el (tooltip-use-echo-area): New user variable.
Sam Steingold <sds@gnu.org>
parents:
30481
diff
changeset
|
235 (message "%s" text) |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
236 (condition-case error |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
237 (let ((params (copy-sequence tooltip-frame-parameters)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
238 (fg (face-attribute 'tooltip :foreground)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
239 (bg (face-attribute 'tooltip :background))) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
240 (when (stringp fg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
241 (setq params (tooltip-set-param params 'foreground-color fg)) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
242 (setq params (tooltip-set-param params 'border-color fg))) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
243 (when (stringp bg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
244 (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
|
245 (x-show-tip (propertize text 'face 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
246 (selected-frame) |
35044 | 247 params |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
248 tooltip-hide-delay |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
249 tooltip-x-offset |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
250 tooltip-y-offset)) |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
251 (error |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
252 (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
|
253 (sit-for 1) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
254 (message "%s" text))))) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
255 |
25003 | 256 (defun tooltip-hide (&optional ignored-arg) |
257 "Hide a tooltip, if one is displayed. | |
258 Value is non-nil if tooltip was open." | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
259 (tooltip-cancel-delayed-tip) |
25003 | 260 (when (x-hide-tip) |
30481 | 261 (setq tooltip-hide-time (float-time)))) |
25003 | 262 |
263 | |
264 ;;; Debugger-related functions | |
265 | |
266 (defun tooltip-identifier-from-point (point) | |
267 "Extract the identifier at POINT, if any. | |
268 Value is nil if no identifier exists at point. Identifier extraction | |
269 is based on the current syntax table." | |
270 (save-excursion | |
271 (goto-char point) | |
272 (let ((start (progn (skip-syntax-backward "w_") (point)))) | |
273 (unless (looking-at "[0-9]") | |
274 (skip-syntax-forward "w_") | |
275 (when (> (point) start) | |
276 (buffer-substring start (point))))))) | |
277 | |
278 (defmacro tooltip-region-active-p () | |
279 "Value is non-nil if the region is currently active." | |
280 (if (string-match "^GNU" (emacs-version)) | |
281 `(and transient-mark-mode mark-active) | |
282 `(region-active-p))) | |
283 | |
284 (defun tooltip-expr-to-print (event) | |
285 "Return an expression that should be printed for EVENT. | |
286 If a region is active and the mouse is inside the region, print | |
287 the region. Otherwise, figure out the identifier around the point | |
288 where the mouse is." | |
289 (save-excursion | |
290 (set-buffer (tooltip-event-buffer event)) | |
291 (let ((point (posn-point (event-end event)))) | |
292 (if (tooltip-region-active-p) | |
293 (when (and (<= (region-beginning) point) (<= point (region-end))) | |
294 (buffer-substring (region-beginning) (region-end))) | |
295 (tooltip-identifier-from-point point))))) | |
296 | |
297 (defun tooltip-process-prompt-regexp (process) | |
298 "Return regexp matching the prompt of PROCESS at the end of a string. | |
63483
8e09dea7559c
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
Juanma Barranquero <lekktu@gmail.com>
parents:
63441
diff
changeset
|
299 The prompt is taken from the value of `comint-prompt-regexp' in |
8e09dea7559c
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
Juanma Barranquero <lekktu@gmail.com>
parents:
63441
diff
changeset
|
300 the buffer of PROCESS." |
25003 | 301 (let ((prompt-regexp (save-excursion |
302 (set-buffer (process-buffer process)) | |
303 comint-prompt-regexp))) | |
304 ;; Most start with `^' but the one for `sdb' cannot be easily | |
305 ;; stripped. Code the prompt for `sdb' fixed here. | |
306 (if (= (aref prompt-regexp 0) ?^) | |
307 (setq prompt-regexp (substring prompt-regexp 1)) | |
308 (setq prompt-regexp "\\*")) | |
309 (concat "\n*" prompt-regexp "$"))) | |
310 | |
311 (defun tooltip-strip-prompt (process output) | |
312 "Return OUTPUT with any prompt of PROCESS stripped from its end." | |
313 (let ((prompt-regexp (tooltip-process-prompt-regexp process))) | |
314 (save-match-data | |
315 (when (string-match prompt-regexp output) | |
316 (setq output (substring output 0 (match-beginning 0))))) | |
317 output)) | |
318 | |
319 | |
320 ;;; Tooltip help. | |
321 | |
322 (defvar tooltip-help-message nil | |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
323 "The last help message received via `tooltip-show-help'.") |
25003 | 324 |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
325 (defun tooltip-show-help (msg) |
25003 | 326 "Function installed as `show-help-function'. |
327 MSG is either a help string to display, or nil to cancel the display." | |
61161
22abf0130979
(tooltip-show-help-function): Don't fixup message here.
Kim F. Storm <storm@cua.dk>
parents:
61128
diff
changeset
|
328 (let ((previous-help tooltip-help-message)) |
25003 | 329 (setq tooltip-help-message msg) |
330 (cond ((null msg) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
331 ;; Cancel display. This also cancels a delayed tip, if |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
332 ;; there is one. |
25003 | 333 (tooltip-hide)) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
334 ((equal previous-help msg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
335 ;; Same help as before (but possibly the mouse has moved). |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
336 ;; Keep what we have. |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
337 ) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
338 (t |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
339 ;; A different help. Remove a previous tooltip, and |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
340 ;; display a new one, with some delay. |
25003 | 341 (tooltip-hide) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
342 (tooltip-start-delayed-tip))))) |
25003 | 343 |
344 (defun tooltip-help-tips (event) | |
345 "Hook function to display a help tooltip. | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
346 This is installed on the hook `tooltip-hook', which is run when |
63483
8e09dea7559c
(tooltip-start-delayed-tip, tooltip-timeout, tooltip-use-echo-area,
Juanma Barranquero <lekktu@gmail.com>
parents:
63441
diff
changeset
|
347 the timer with id `tooltip-timeout-id' fires. |
25003 | 348 Value is non-nil if this function handled the tip." |
349 (when (stringp tooltip-help-message) | |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
350 (tooltip-show tooltip-help-message tooltip-use-echo-area) |
25003 | 351 t)) |
352 | |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
353 (provide 'tooltip) |
25003 | 354 |
58155 | 355 ;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f |
25003 | 356 ;;; tooltip.el ends here |