Mercurial > emacs
annotate lisp/tooltip.el @ 99213:33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
* tooltip.el (tooltip-functions): Rename from `tooltip-hook',
to follow naming conventions for abnormal hooks. Doc fix.
(tooltip-mode, tooltip-timeout): Use it.
(tooltip-hook): New obsolete alias.
(tooltip-help-tips): Doc fix.
* progmodes/gud.el (gud-tooltip-mode): Use `tooltip-functions'.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Wed, 29 Oct 2008 12:10:20 +0000 |
parents | 68a220b546b7 |
children | 563e71d339f2 |
rev | line source |
---|---|
45236 | 1 ;;; tooltip.el --- show tooltip windows |
25003 | 2 |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64626
diff
changeset
|
3 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, |
79721 | 4 ;; 2005, 2006, 2007, 2008 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 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94186
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
25003 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94186
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94186
diff
changeset
|
14 ;; (at your option) any later version. |
25003 | 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 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
94186
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
25003 | 23 |
24 ;;; Commentary: | |
25 | |
26 ;;; Code: | |
27 | |
65297
1cb15495a842
(comint-prompt-regexp): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64762
diff
changeset
|
28 (defvar comint-prompt-regexp) |
1cb15495a842
(comint-prompt-regexp): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
64762
diff
changeset
|
29 |
67706
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
30 (defgroup tooltip nil |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
31 "Customization group for the `tooltip' package." |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
32 :group 'help |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
33 :group 'gud |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
34 :group 'mouse |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
35 :group 'tools |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
36 :version "21.1" |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
37 :tag "Tool Tips") |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
38 |
67485
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
39 ;;; Switching tooltips on/off |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
40 |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
41 (define-minor-mode tooltip-mode |
70099
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
42 "Toggle Tooltip mode. |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
43 With ARG, turn Tooltip mode on if and only if ARG is positive. |
68141
e97b6ce08cb9
(tooltip-mode): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
67706
diff
changeset
|
44 When this minor mode is enabled, Emacs displays help text |
70099
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
45 in a pop-up window for buttons and menu items that you put the mouse on. |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
46 \(However, if `tooltip-use-echo-area' is non-nil, this and |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
47 all pop-up help appears in the echo area.) |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
48 |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
49 When Tooltip mode is disabled, Emacs displays one line of |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
50 the help text in the echo area, and does not make a pop-up window." |
67485
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
51 :global t |
98061
68a220b546b7
(tooltip-mode): Initialize unconditionally to t.
Chong Yidong <cyd@stupidchicken.com>
parents:
95841
diff
changeset
|
52 ;; Even if we start on a text-only terminal, make this non-nil by |
68a220b546b7
(tooltip-mode): Initialize unconditionally to t.
Chong Yidong <cyd@stupidchicken.com>
parents:
95841
diff
changeset
|
53 ;; default because we can open a graphical frame later (multi-tty). |
68a220b546b7
(tooltip-mode): Initialize unconditionally to t.
Chong Yidong <cyd@stupidchicken.com>
parents:
95841
diff
changeset
|
54 :init-value t |
67485
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
55 :initialize 'custom-initialize-safe-default |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
56 :group 'tooltip |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
57 (unless (or (null tooltip-mode) (fboundp 'x-show-tip)) |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
58 (error "Sorry, tooltips are not yet available on this system")) |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
59 (if tooltip-mode |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
60 (progn |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
61 (add-hook 'pre-command-hook 'tooltip-hide) |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
62 (add-hook 'tooltip-functions 'tooltip-help-tips)) |
67485
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
63 (unless (and (boundp 'gud-tooltip-mode) gud-tooltip-mode) |
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
64 (remove-hook 'pre-command-hook 'tooltip-hide)) |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
65 (remove-hook 'tooltip-functions 'tooltip-help-tips)) |
67485
2865d1195586
(tooltip-mode): Move to start of file so that it
Nick Roberts <nickrob@snap.net.nz>
parents:
66348
diff
changeset
|
66 (setq show-help-function |
93905
529aa606e975
(tooltip-mode): Set tooltip-show-help-non-mode as
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
67 (if tooltip-mode 'tooltip-show-help 'tooltip-show-help-non-mode))) |
25003 | 68 |
67706
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
69 |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
70 ;;; Customizable settings |
25003 | 71 |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
72 (defcustom tooltip-delay 0.7 |
25003 | 73 "Seconds to wait before displaying a tooltip the first time." |
74 :type 'number | |
75 :group 'tooltip) | |
76 | |
77 (defcustom tooltip-short-delay 0.1 | |
78 "Seconds to wait between subsequent tooltips on different items." | |
79 :type 'number | |
80 :group 'tooltip) | |
81 | |
82 (defcustom tooltip-recent-seconds 1 | |
25332
c09e05be2f4b
(tooltip-mode): Customize this, per convention.
Dave Love <fx@gnu.org>
parents:
25003
diff
changeset
|
83 "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
|
84 Do so after `tooltip-short-delay'." |
25003 | 85 :type 'number |
86 :group 'tooltip) | |
87 | |
40679
3c4df1ce9e4c
(tooltip-delay): Decrease to 0.7.
Eli Zaretskii <eliz@gnu.org>
parents:
40376
diff
changeset
|
88 (defcustom tooltip-hide-delay 10 |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
89 "Hide tooltips automatically after this many seconds." |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
90 :type 'number |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
91 :group 'tooltip) |
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
92 |
66348
834a001192cb
(tooltip-x-offset, tooltip-y-offset): Change defaults.
Richard M. Stallman <rms@gnu.org>
parents:
65732
diff
changeset
|
93 (defcustom tooltip-x-offset 5 |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
94 "X offset, in pixels, for the display of tooltips. |
67706
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
95 The offset is the distance between the X position of the mouse and |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
96 the left border of the tooltip window. It must be chosen so that the |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
97 tooltip window doesn't contain the mouse when it pops up, or it may |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
98 interfere with clicking where you wish. |
40173
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 `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
|
101 the value of `tooltip-x-offset' is ignored." |
66348
834a001192cb
(tooltip-x-offset, tooltip-y-offset): Change defaults.
Richard M. Stallman <rms@gnu.org>
parents:
65732
diff
changeset
|
102 :type 'integer |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
103 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
104 |
67531
525cba59adb2
Changed default to 20 for tooltip-y-offset.
Jan Djärv <jan.h.d@swipnet.se>
parents:
67485
diff
changeset
|
105 (defcustom tooltip-y-offset +20 |
46025
ce0d438fe05e
(tooltip-x-offset, tooltip-y-offset): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
45571
diff
changeset
|
106 "Y offset, in pixels, for the display of tooltips. |
67706
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
107 The offset is the distance between the Y position of the mouse and |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
108 the top border of the tooltip window. It must be chosen so that the |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
109 tooltip window doesn't contain the mouse when it pops up, or it may |
05fd43fc72e9
(tooltip): Move defgroup before define-minor-mode.
Juri Linkov <juri@jurta.org>
parents:
67597
diff
changeset
|
110 interfere with clicking where you wish. |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
111 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
112 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
|
113 the value of `tooltip-y-offset' is ignored." |
66348
834a001192cb
(tooltip-x-offset, tooltip-y-offset): Change defaults.
Richard M. Stallman <rms@gnu.org>
parents:
65732
diff
changeset
|
114 :type 'integer |
33587
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
115 :group 'tooltip) |
7d4c3fcd3421
(tooltip-x-offset, tooltip-y-offset): New user-options.
Gerd Moellmann <gerd@gnu.org>
parents:
33356
diff
changeset
|
116 |
25003 | 117 (defcustom tooltip-frame-parameters |
118 '((name . "tooltip") | |
66348
834a001192cb
(tooltip-x-offset, tooltip-y-offset): Change defaults.
Richard M. Stallman <rms@gnu.org>
parents:
65732
diff
changeset
|
119 (internal-border-width . 2) |
25003 | 120 (border-width . 1)) |
40173
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
121 "Frame parameters used for tooltips. |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
122 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
123 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
|
124 position to pop up the tooltip." |
25003 | 125 :type 'sexp |
126 :group 'tooltip) | |
127 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
128 (defface tooltip |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
129 '((((class color)) |
52031
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
130 :background "lightyellow" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
131 :foreground "black" |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
132 :inherit variable-pitch) |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
133 (t |
5163fa137977
(defface tooltip): Inherit from variable-pitch.
John Paul Wallington <jpw@pobox.com>
parents:
49597
diff
changeset
|
134 :inherit variable-pitch)) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
135 "Face for tooltips." |
65732
cd8e6d86c531
(tooltip): Add group `basic-faces'.
Juri Linkov <juri@jurta.org>
parents:
65297
diff
changeset
|
136 :group 'tooltip |
cd8e6d86c531
(tooltip): Add group `basic-faces'.
Juri Linkov <juri@jurta.org>
parents:
65297
diff
changeset
|
137 :group 'basic-faces) |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
138 |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
139 (defcustom tooltip-use-echo-area nil |
70099
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
140 "Use the echo area instead of tooltip frames for help and GUD tooltips. |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
141 To display multi-line help text in the echo area, set this to t |
7ab0f5013dfb
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents:
68651
diff
changeset
|
142 and enable `tooltip-mode'." |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
143 :type 'boolean |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
144 :group 'tooltip) |
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
145 |
25003 | 146 |
147 ;;; Variables that are not customizable. | |
148 | |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
149 (defvar tooltip-functions nil |
25003 | 150 "Functions to call to display tooltips. |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
151 Each function is called with one argument EVENT which is a copy |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
152 of the last mouse movement event that occurred. If one of these |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
153 functions displays the tooltip, it should return non-nil and the |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
154 rest are not called.") |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
155 |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
156 (define-obsolete-variable-alias 'tooltip-hook 'tooltip-functions "23.1") |
25003 | 157 |
158 (defvar tooltip-timeout-id nil | |
159 "The id of the timeout started when Emacs becomes idle.") | |
160 | |
161 (defvar tooltip-last-mouse-motion-event nil | |
162 "A copy of the last mouse motion event seen.") | |
163 | |
164 (defvar tooltip-hide-time nil | |
165 "Time when the last tooltip was hidden.") | |
166 | |
63938
cd982981d99a
(gud-tooltip-mode): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents:
63587
diff
changeset
|
167 (defvar gud-tooltip-mode) ;; Prevent warning. |
cd982981d99a
(gud-tooltip-mode): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents:
63587
diff
changeset
|
168 |
25003 | 169 ;;; Event accessors |
170 | |
171 (defun tooltip-event-buffer (event) | |
172 "Return the buffer over which event EVENT occurred. | |
173 This might return nil if the event did not occur over a buffer." | |
174 (let ((window (posn-window (event-end event)))) | |
175 (and window (window-buffer window)))) | |
176 | |
177 | |
178 ;;; Timeout for tooltip display | |
179 | |
180 (defun tooltip-delay () | |
181 "Return the delay in seconds for the next tooltip." | |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
182 (if (and tooltip-hide-time |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
183 (< (- (float-time) tooltip-hide-time) tooltip-recent-seconds)) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
184 tooltip-short-delay |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
185 tooltip-delay)) |
25003 | 186 |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
187 (defun tooltip-cancel-delayed-tip () |
25003 | 188 "Disable the tooltip timeout." |
189 (when tooltip-timeout-id | |
190 (disable-timeout tooltip-timeout-id) | |
191 (setq tooltip-timeout-id nil))) | |
192 | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
193 (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
|
194 "Add a one-shot timeout to call function `tooltip-timeout'." |
25003 | 195 (setq tooltip-timeout-id |
196 (add-timeout (tooltip-delay) 'tooltip-timeout nil))) | |
197 | |
198 (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
|
199 "Function called when timer with id `tooltip-timeout-id' fires." |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
200 (run-hook-with-args-until-success 'tooltip-functions |
25003 | 201 tooltip-last-mouse-motion-event)) |
202 | |
203 | |
204 ;;; Displaying tips | |
205 | |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
206 (defun tooltip-set-param (alist key value) |
40178
1dab42ecd751
(tooltip-set-param): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
40173
diff
changeset
|
207 "Change the value of KEY in alist ALIST to VALUE. |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
208 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
|
209 change the existing association. Value is the resulting alist." |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
210 (let ((param (assq key alist))) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
211 (if (consp param) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
212 (setcdr param value) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
213 (push (cons key value) alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
214 alist)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
215 |
95841
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
216 (declare-function x-show-tip "xfns.c" |
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
217 (string &optional frame parms timeout dx dy)) |
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
218 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
219 (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
|
220 "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
|
221 |
61608
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
222 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
|
223 |
c4955867228d
(tooltip-x-offset, tooltip-y-offset): Mention in the
Eli Zaretskii <eliz@gnu.org>
parents:
37755
diff
changeset
|
224 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
|
225 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
|
226 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
|
227 `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
|
228 position. |
6a8ebeaf5f56
(tooltip-gud-echo-area): Rename from
Nick Roberts <nickrob@snap.net.nz>
parents:
61565
diff
changeset
|
229 |
61626
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
230 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
|
231 in echo area." |
058da2e83614
(tooltip-show): Change second arg to USE-ECHO-AREA
Kim F. Storm <storm@cua.dk>
parents:
61614
diff
changeset
|
232 (if use-echo-area |
93905
529aa606e975
(tooltip-mode): Set tooltip-show-help-non-mode as
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
233 (tooltip-show-help-non-mode text) |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
234 (condition-case error |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
235 (let ((params (copy-sequence tooltip-frame-parameters)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
236 (fg (face-attribute 'tooltip :foreground)) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
237 (bg (face-attribute 'tooltip :background))) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
238 (when (stringp fg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
239 (setq params (tooltip-set-param params 'foreground-color fg)) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
240 (setq params (tooltip-set-param params 'border-color fg))) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
241 (when (stringp bg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
242 (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
|
243 (x-show-tip (propertize text 'face 'tooltip) |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
244 (selected-frame) |
35044 | 245 params |
35401
c00e94a506a2
(tooltip-hide-delay): New user-option.
Gerd Moellmann <gerd@gnu.org>
parents:
35069
diff
changeset
|
246 tooltip-hide-delay |
35043
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
247 tooltip-x-offset |
f7ca93e40e16
(tooltip-frame-parameters): Remove colors.
Gerd Moellmann <gerd@gnu.org>
parents:
34689
diff
changeset
|
248 tooltip-y-offset)) |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
249 (error |
34540
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
250 (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
|
251 (sit-for 1) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
252 (message "%s" text))))) |
e1e4704de6ed
(tooltip-show): If an error is signaled in
Gerd Moellmann <gerd@gnu.org>
parents:
33925
diff
changeset
|
253 |
95841
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
254 (declare-function x-hide-tip "xfns.c" ()) |
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
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 () | |
87404 | 279 "Value is non-nil if the region should override command actions." |
87403
f6740b43efae
(tooltip-region-active-p): Use `use-region-p'.
Richard M. Stallman <rms@gnu.org>
parents:
85529
diff
changeset
|
280 `(use-region-p)) |
25003 | 281 |
282 (defun tooltip-expr-to-print (event) | |
283 "Return an expression that should be printed for EVENT. | |
284 If a region is active and the mouse is inside the region, print | |
285 the region. Otherwise, figure out the identifier around the point | |
286 where the mouse is." | |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
287 (with-current-buffer (tooltip-event-buffer event) |
25003 | 288 (let ((point (posn-point (event-end event)))) |
289 (if (tooltip-region-active-p) | |
290 (when (and (<= (region-beginning) point) (<= point (region-end))) | |
291 (buffer-substring (region-beginning) (region-end))) | |
292 (tooltip-identifier-from-point point))))) | |
293 | |
294 (defun tooltip-process-prompt-regexp (process) | |
295 "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
|
296 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
|
297 the buffer of PROCESS." |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
298 (let ((prompt-regexp (with-current-buffer (process-buffer process) |
25003 | 299 comint-prompt-regexp))) |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
300 (concat "\n*" |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
301 ;; Most start with `^' but the one for `sdb' cannot be easily |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
302 ;; stripped. Code the prompt for `sdb' fixed here. |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
303 (if (= (aref prompt-regexp 0) ?^) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
304 (substring prompt-regexp 1) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
305 "\\*") |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
306 "$"))) |
25003 | 307 |
308 (defun tooltip-strip-prompt (process output) | |
309 "Return OUTPUT with any prompt of PROCESS stripped from its end." | |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
310 (save-match-data |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
311 (if (string-match (tooltip-process-prompt-regexp process) output) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
312 (substring output 0 (match-beginning 0)) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
313 output))) |
25003 | 314 |
315 | |
316 ;;; Tooltip help. | |
317 | |
318 (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
|
319 "The last help message received via `tooltip-show-help'.") |
25003 | 320 |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
321 (defvar tooltip-previous-message nil |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
322 "The previous content of the echo area.") |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
323 |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
324 (defun tooltip-show-help-non-mode (help) |
93905
529aa606e975
(tooltip-mode): Set tooltip-show-help-non-mode as
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
325 "Function installed as `show-help-function' when tooltip is off." |
94186
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
326 (when (and (not (window-minibuffer-p)) ;Don't overwrite minibuffer contents. |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
327 ;; Don't know how to reproduce it in Elisp: |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
328 ;; Don't overwrite a keystroke echo. |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
329 ;; (NILP (echo_message_buffer) || ok_to_overwrite_keystroke_echo) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
330 (not cursor-in-echo-area)) ;Don't overwrite a prompt. |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
331 (cond |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
332 ((stringp help) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
333 (unless tooltip-previous-message |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
334 (setq tooltip-previous-message (current-message))) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
335 (let ((message-truncate-lines t) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
336 (message-log-max nil)) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
337 (message "%s" (replace-regexp-in-string "\n" ", " help)))) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
338 ((stringp tooltip-previous-message) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
339 (let ((message-log-max nil)) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
340 (message "%s" tooltip-previous-message) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
341 (setq tooltip-previous-message nil))) |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
342 (t |
7870d07a291c
* tooltip.el (tooltip-previous-message): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
93998
diff
changeset
|
343 (message nil))))) |
93905
529aa606e975
(tooltip-mode): Set tooltip-show-help-non-mode as
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
344 |
63441
ebbf98a044ac
* tooltip.el (tooltip-use-echo-area): Restore from gud.el for
Nick Roberts <nickrob@snap.net.nz>
parents:
62135
diff
changeset
|
345 (defun tooltip-show-help (msg) |
25003 | 346 "Function installed as `show-help-function'. |
347 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
|
348 (let ((previous-help tooltip-help-message)) |
25003 | 349 (setq tooltip-help-message msg) |
350 (cond ((null msg) | |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
351 ;; Cancel display. This also cancels a delayed tip, if |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
352 ;; there is one. |
25003 | 353 (tooltip-hide)) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
354 ((equal previous-help msg) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
355 ;; Same help as before (but possibly the mouse has moved). |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
356 ;; Keep what we have. |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
357 ) |
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
358 (t |
49597
e88404e8f2cf
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48925
diff
changeset
|
359 ;; A different help. Remove a previous tooltip, and |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
360 ;; display a new one, with some delay. |
25003 | 361 (tooltip-hide) |
35069
d19eadb47c76
(tooltip-cancel-delayed-tip)
Gerd Moellmann <gerd@gnu.org>
parents:
35044
diff
changeset
|
362 (tooltip-start-delayed-tip))))) |
25003 | 363 |
364 (defun tooltip-help-tips (event) | |
365 "Hook function to display a help tooltip. | |
99213
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
366 This is installed on the hook `tooltip-functions', which |
33f78208d5f0
Rename `tooltip-hook' to `tooltip-functions'.
Juanma Barranquero <lekktu@gmail.com>
parents:
98061
diff
changeset
|
367 is run when the timer with id `tooltip-timeout-id' fires. |
25003 | 368 Value is non-nil if this function handled the tip." |
369 (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
|
370 (tooltip-show tooltip-help-message tooltip-use-echo-area) |
25003 | 371 t)) |
372 | |
48601
ac47e19224b0
(tooltip-gud-process-output): Handle annotations that
Nick Roberts <nickrob@snap.net.nz>
parents:
48580
diff
changeset
|
373 (provide 'tooltip) |
25003 | 374 |
58155 | 375 ;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f |
25003 | 376 ;;; tooltip.el ends here |