tooltip.el 18.2 KB
Newer Older
Pavel Janík's avatar
Pavel Janík committed
1
;;; tooltip.el --- show tooltip windows
Gerd Moellmann's avatar
Gerd Moellmann committed
2

3
;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004, 2005
4
;;        Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

;; Author: Gerd Moellmann <gerd@acm.org>
;; Keywords: help c mouse tools

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

30
(eval-when-compile (require 'cl)) ; for case macro
Stefan Monnier's avatar
Stefan Monnier committed
31

Gerd Moellmann's avatar
Gerd Moellmann committed
32 33 34 35 36 37

;;; Customizable settings

(defgroup tooltip nil
  "Customization group for the `tooltip' package."
  :group 'help
38
  :group 'gud
Gerd Moellmann's avatar
Gerd Moellmann committed
39 40
  :group 'mouse
  :group 'tools
41
  :version "21.1"
Gerd Moellmann's avatar
Gerd Moellmann committed
42 43
  :tag "Tool Tips")

44
(defcustom tooltip-delay 0.7
Gerd Moellmann's avatar
Gerd Moellmann committed
45 46 47 48 49 50 51 52 53 54 55 56
  "Seconds to wait before displaying a tooltip the first time."
  :tag "Delay"
  :type 'number
  :group 'tooltip)

(defcustom tooltip-short-delay 0.1
  "Seconds to wait between subsequent tooltips on different items."
  :tag "Short delay"
  :type 'number
  :group 'tooltip)

(defcustom tooltip-recent-seconds 1
57 58
  "Display tooltips if changing tip items within this many seconds.
Do so after `tooltip-short-delay'."
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62
  :tag "Recent seconds"
  :type 'number
  :group 'tooltip)

63
(defcustom tooltip-hide-delay 10
64 65 66 67 68
  "Hide tooltips automatically after this many seconds."
  :tag "Hide delay"
  :type 'number
  :group 'tooltip)

69
(defcustom tooltip-x-offset nil
70
  "X offset, in pixels, for the display of tooltips.
71 72
The offset is relative to the position of the mouse.  It must
be chosen so that the tooltip window doesn't contain the mouse
73 74 75 76 77
when it pops up.  If the value is nil, the default offset is 5
pixels.

If `tooltip-frame-parameters' includes the `left' parameter,
the value of `tooltip-x-offset' is ignored."
78 79 80 81 82 83
  :tag "X offset"
  :type '(choice (const :tag "Default" nil)
		 (integer :tag "Offset" :value 1))
  :group 'tooltip)

(defcustom tooltip-y-offset nil
84
  "Y offset, in pixels, for the display of tooltips.
85 86
The offset is relative to the position of the mouse.  It must
be chosen so that the tooltip window doesn't contain the mouse
87 88 89 90 91
when it pops up.  If the value is nil, the default offset is -10
pixels.

If `tooltip-frame-parameters' includes the `top' parameter,
the value of `tooltip-y-offset' is ignored."
92 93 94 95 96
  :tag "Y offset"
  :type '(choice (const :tag "Default" nil)
		 (integer :tag "Offset" :value 1))
  :group 'tooltip)

Gerd Moellmann's avatar
Gerd Moellmann committed
97 98 99 100
(defcustom tooltip-frame-parameters
  '((name . "tooltip")
    (internal-border-width . 5)
    (border-width . 1))
101 102 103 104
  "Frame parameters used for tooltips.

If `left' or `top' parameters are included, they specify the absolute
position to pop up the tooltip."
Gerd Moellmann's avatar
Gerd Moellmann committed
105 106 107 108
  :type 'sexp
  :tag "Frame Parameters"
  :group 'tooltip)

109 110
(defface tooltip
  '((((class color))
111 112 113 114 115
     :background "lightyellow"
     :foreground "black"
     :inherit variable-pitch)
    (t
     :inherit variable-pitch))
116 117 118
  "Face for tooltips."
  :group 'tooltip)

Gerd Moellmann's avatar
Gerd Moellmann committed
119
(defcustom tooltip-gud-tips-p nil
120 121
  "*Non-nil means show tooltips in GUD sessions.

122 123 124 125
This allows you to display a variable's value in a tooltip simply
by pointing at it with the mouse.  In the case of a C program
controlled by GDB, it shows the associated #define directives
when program is not executing."
Gerd Moellmann's avatar
Gerd Moellmann committed
126 127 128 129
  :type 'boolean
  :tag "GUD"
  :group 'tooltip)

130
(defcustom tooltip-gud-modes '(gud-mode c-mode c++-mode fortran-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
131 132 133 134 135 136 137
  "List of modes for which to enable GUD tips."
  :type 'sexp
  :tag "GUD modes"
  :group 'tooltip)

(defcustom tooltip-gud-display
  '((eq (tooltip-event-buffer tooltip-gud-event)
138
	(marker-buffer gud-overlay-arrow-position)))
Gerd Moellmann's avatar
Gerd Moellmann committed
139 140 141 142 143 144 145 146
  "List of forms determining where GUD tooltips are displayed.

Forms in the list are combined with AND.  The default is to display
only tooltips in the buffer containing the overlay arrow."
  :type 'sexp
  :tag "GUD buffers predicate"
  :group 'tooltip)

147 148
(defcustom tooltip-gud-echo-area nil
  "Use the echo area instead of frames for GUD tooltips."
149
  :type 'boolean
Dave Love's avatar
Dave Love committed
150
  :tag "Use echo area"
151 152
  :group 'tooltip)

153 154
(defvaralias 'tooltip-use-echo-area 'tooltip-gud-echo-area)
(make-obsolete-variable 'tooltip-use-echo-area 'tooltip-gud-echo-area "22.1")
Gerd Moellmann's avatar
Gerd Moellmann committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190

;;; Variables that are not customizable.

(defvar tooltip-hook nil
  "Functions to call to display tooltips.
Each function is called with one argument EVENT which is a copy of
the last mouse movement event that occurred.")

(defvar tooltip-timeout-id nil
  "The id of the timeout started when Emacs becomes idle.")

(defvar tooltip-last-mouse-motion-event nil
  "A copy of the last mouse motion event seen.")

(defvar tooltip-hide-time nil
  "Time when the last tooltip was hidden.")


;;; Event accessors

(defun tooltip-event-buffer (event)
  "Return the buffer over which event EVENT occurred.
This might return nil if the event did not occur over a buffer."
  (let ((window (posn-window (event-end event))))
    (and window (window-buffer window))))


;;; Switching tooltips on/off

;; We don't set track-mouse globally because this is a big redisplay
;; problem in buffers having a pre-command-hook or such installed,
;; which does a set-buffer, like the summary buffer of Gnus.  Calling
;; set-buffer prevents redisplay optimizations, so every mouse motion
;; would be accompanied by a full redisplay.

;;;###autoload
191 192
(define-minor-mode tooltip-mode
  "Toggle Tooltip display.
Gerd Moellmann's avatar
Gerd Moellmann committed
193
With ARG, turn tooltip mode on if and only if ARG is positive."
194
  :global t
195 196 197
  ;; If you change the :init-value below, you also need to change the
  ;; corresponding code in startup.el.
  :init-value (not (or noninteractive
198 199 200
		       (and (boundp 'emacs-quick-startup) emacs-quick-startup)
		       (not (and (fboundp 'display-graphic-p)
				 (display-graphic-p)))
201
		       (not (fboundp 'x-show-tip))))
202
  :group 'tooltip
203
  (unless (or (null tooltip-mode) (fboundp 'x-show-tip))
204
    (error "Sorry, tooltips are not yet available on this system"))
205
  (let ((hook-fn (if tooltip-mode 'add-hook 'remove-hook)))
Gerd Moellmann's avatar
Gerd Moellmann committed
206 207 208 209 210
    (funcall hook-fn 'change-major-mode-hook 'tooltip-change-major-mode)
    (tooltip-activate-mouse-motions-if-enabled)
    (funcall hook-fn 'pre-command-hook 'tooltip-hide)
    (funcall hook-fn 'tooltip-hook 'tooltip-gud-tips)
    (funcall hook-fn 'tooltip-hook 'tooltip-help-tips)
211
    (setq show-help-function (if tooltip-mode 'tooltip-show-help-function nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
212 213
    ;; `ignore' is the default binding for mouse movements.
    (define-key global-map [mouse-movement]
214
      (if tooltip-mode 'tooltip-mouse-motion 'ignore))))
215

Gerd Moellmann's avatar
Gerd Moellmann committed
216 217 218 219 220 221

;;; Timeout for tooltip display

(defun tooltip-delay ()
  "Return the delay in seconds for the next tooltip."
  (let ((delay tooltip-delay)
Sam Steingold's avatar
Sam Steingold committed
222
	(now (float-time)))
Gerd Moellmann's avatar
Gerd Moellmann committed
223 224 225 226 227
    (when (and tooltip-hide-time
	       (< (- now tooltip-hide-time) tooltip-recent-seconds))
      (setq delay tooltip-short-delay))
    delay))

Gerd Moellmann's avatar
Gerd Moellmann committed
228
(defun tooltip-cancel-delayed-tip ()
Gerd Moellmann's avatar
Gerd Moellmann committed
229 230 231 232 233
  "Disable the tooltip timeout."
  (when tooltip-timeout-id
    (disable-timeout tooltip-timeout-id)
    (setq tooltip-timeout-id nil)))

Gerd Moellmann's avatar
Gerd Moellmann committed
234
(defun tooltip-start-delayed-tip ()
Gerd Moellmann's avatar
Gerd Moellmann committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  "Add a one-shot timeout to call function tooltip-timeout."
  (setq tooltip-timeout-id
	(add-timeout (tooltip-delay) 'tooltip-timeout nil)))

(defun tooltip-timeout (object)
  "Function called when timer with id tooltip-timeout-id fires."
  (run-hook-with-args-until-success 'tooltip-hook
				    tooltip-last-mouse-motion-event))


;;; Reacting on mouse movements

(defun tooltip-change-major-mode ()
  "Function added to `change-major-mode-hook' when tooltip mode is on."
  (add-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled))

(defun tooltip-activate-mouse-motions-if-enabled ()
  "Reconsider for all buffers whether mouse motion events are desired."
  (remove-hook 'post-command-hook 'tooltip-activate-mouse-motions-if-enabled)
254
  (dolist (buffer (buffer-list))
Gerd Moellmann's avatar
Gerd Moellmann committed
255
    (save-excursion
256 257 258 259 260 261
      (set-buffer buffer)
      (if (and tooltip-mode
	       tooltip-gud-tips-p
	       (memq major-mode tooltip-gud-modes))
	  (tooltip-activate-mouse-motions t)
	(tooltip-activate-mouse-motions nil)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
262

263 264
(defvar tooltip-mouse-motions-active nil
  "Locally t in a buffer if tooltip processing of mouse motion is enabled.")
Gerd Moellmann's avatar
Gerd Moellmann committed
265 266 267 268 269 270

(defun tooltip-activate-mouse-motions (activatep)
  "Activate/deactivate mouse motion events for the current buffer.
ACTIVATEP non-nil means activate mouse motion events."
  (if activatep
      (progn
271 272
	(make-local-variable 'tooltip-mouse-motions-active)
	(setq tooltip-mouse-motions-active t)
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274
	(make-local-variable 'track-mouse)
	(setq track-mouse t))
275 276 277
    (when tooltip-mouse-motions-active
      (kill-local-variable 'tooltip-mouse-motions-active)
      (kill-local-variable 'track-mouse))))
Gerd Moellmann's avatar
Gerd Moellmann committed
278 279 280 281 282 283 284

(defun tooltip-mouse-motion (event)
  "Command handler for mouse movement events in `global-map'."
  (interactive "e")
  (tooltip-hide)
  (when (car (mouse-pixel-position))
    (setq tooltip-last-mouse-motion-event (copy-sequence event))
Gerd Moellmann's avatar
Gerd Moellmann committed
285
    (tooltip-start-delayed-tip)))
Gerd Moellmann's avatar
Gerd Moellmann committed
286 287 288 289


;;; Displaying tips

290
(defun tooltip-set-param (alist key value)
Eli Zaretskii's avatar
Eli Zaretskii committed
291
  "Change the value of KEY in alist ALIST to VALUE.
292
If there's no association for KEY in ALIST, add one, otherwise
293 294 295 296 297 298 299
change the existing association.  Value is the resulting alist."
  (let ((param (assq key alist)))
    (if (consp param)
	(setcdr param value)
      (push (cons key value) alist))
    alist))

300
(defun tooltip-show (text &optional use-echo-area)
301 302
  "Show a tooltip window displaying TEXT.

303
Text larger than `x-max-tooltip-size' is clipped.
304 305 306 307 308

If the alist in `tooltip-frame-parameters' includes `left' and `top'
parameters, they determine the x and y position where the tooltip
is displayed.  Otherwise, the tooltip pops at offsets specified by
`tooltip-x-offset' and `tooltip-y-offset' from the current mouse
309 310
position.

311 312 313
Optional second arg USE-ECHO-AREA non-nil means to show tooltip
in echo area."
  (if use-echo-area
314
      (message "%s" text)
315
    (condition-case error
316 317 318
	(let ((params (copy-sequence tooltip-frame-parameters))
	      (fg (face-attribute 'tooltip :foreground))
	      (bg (face-attribute 'tooltip :background)))
Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321 322 323
	  (when (stringp fg)
	    (setq params (tooltip-set-param params 'foreground-color fg))
	    (setq params (tooltip-set-param params 'border-color fg)))
	  (when (stringp bg)
	    (setq params (tooltip-set-param params 'background-color bg)))
324 325
	  (x-show-tip (propertize text 'face 'tooltip)
		      (selected-frame)
Gerd Moellmann's avatar
Gerd Moellmann committed
326
		      params
327
		      tooltip-hide-delay
328 329
		      tooltip-x-offset
		      tooltip-y-offset))
330
      (error
331 332 333 334
       (message "Error while displaying tooltip: %s" error)
       (sit-for 1)
       (message "%s" text)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
335 336 337
(defun tooltip-hide (&optional ignored-arg)
  "Hide a tooltip, if one is displayed.
Value is non-nil if tooltip was open."
Gerd Moellmann's avatar
Gerd Moellmann committed
338
  (tooltip-cancel-delayed-tip)
Gerd Moellmann's avatar
Gerd Moellmann committed
339
  (when (x-hide-tip)
Sam Steingold's avatar
Sam Steingold committed
340
    (setq tooltip-hide-time (float-time))))
Gerd Moellmann's avatar
Gerd Moellmann committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412


;;; Debugger-related functions

(defun tooltip-identifier-from-point (point)
  "Extract the identifier at POINT, if any.
Value is nil if no identifier exists at point.  Identifier extraction
is based on the current syntax table."
  (save-excursion
    (goto-char point)
    (let ((start (progn (skip-syntax-backward "w_") (point))))
      (unless (looking-at "[0-9]")
	(skip-syntax-forward "w_")
	(when (> (point) start)
	  (buffer-substring start (point)))))))

(defmacro tooltip-region-active-p ()
  "Value is non-nil if the region is currently active."
  (if (string-match "^GNU" (emacs-version))
      `(and transient-mark-mode mark-active)
    `(region-active-p)))

(defun tooltip-expr-to-print (event)
  "Return an expression that should be printed for EVENT.
If a region is active and the mouse is inside the region, print
the region.  Otherwise, figure out the identifier around the point
where the mouse is."
  (save-excursion
    (set-buffer (tooltip-event-buffer event))
    (let ((point (posn-point (event-end event))))
      (if (tooltip-region-active-p)
	  (when (and (<= (region-beginning) point) (<= point (region-end)))
	    (buffer-substring (region-beginning) (region-end)))
	(tooltip-identifier-from-point point)))))

(defun tooltip-process-prompt-regexp (process)
  "Return regexp matching the prompt of PROCESS at the end of a string.
The prompt is taken from the value of COMINT-PROMPT-REGEXP in the buffer
of PROCESS."
  (let ((prompt-regexp (save-excursion
			 (set-buffer (process-buffer process))
			 comint-prompt-regexp)))
    ;; Most start with `^' but the one for `sdb' cannot be easily
    ;; stripped.  Code the prompt for `sdb' fixed here.
    (if (= (aref prompt-regexp 0) ?^)
	(setq prompt-regexp (substring prompt-regexp 1))
      (setq prompt-regexp "\\*"))
    (concat "\n*" prompt-regexp "$")))

(defun tooltip-strip-prompt (process output)
  "Return OUTPUT with any prompt of PROCESS stripped from its end."
  (let ((prompt-regexp (tooltip-process-prompt-regexp process)))
    (save-match-data
      (when (string-match prompt-regexp output)
	(setq output (substring output 0 (match-beginning 0)))))
    output))


;;; Tips for `gud'

(defvar tooltip-gud-original-filter nil
  "Process filter to restore after GUD output has been received.")

(defvar tooltip-gud-dereference nil
  "Non-nil means print expressions with a `*' in front of them.
For C this would dereference a pointer expression.")

(defvar tooltip-gud-event nil
  "The mouse movement event that led to a tooltip display.
This event can be examined by forms in TOOLTIP-GUD-DISPLAY.")

(defun tooltip-gud-toggle-dereference ()
413
  "Toggle whether tooltips should show `* expr' or `expr'."
Gerd Moellmann's avatar
Gerd Moellmann committed
414 415 416 417 418 419
  (interactive)
  (setq tooltip-gud-dereference (not tooltip-gud-dereference))
  (when (interactive-p)
    (message "Dereferencing is now %s."
	     (if tooltip-gud-dereference "on" "off"))))

420 421 422 423 424 425 426 427 428 429
(defun tooltip-toggle-gud-tips ()
  "Toggle the display of GUD tooltips."
  (interactive)
  (setq tooltip-gud-tips-p (not tooltip-gud-tips-p))
  ;; Reconsider for all buffers whether mouse motion events are desired.
  (tooltip-change-major-mode)
  (when (interactive-p)
    (message (format "GUD tooltips %sabled"
		     (if tooltip-gud-tips-p "en" "dis")))))

430
; This will only display data that comes in one chunk.
431
; Larger arrays (say 400 elements) are displayed in
432
; the tootip incompletely and spill over into the gud buffer.
433
; Switching the process-filter creates timing problems and
434 435
; it may be difficult to do better. Using annotations as in
; gdb-ui.el gets round this problem.
Gerd Moellmann's avatar
Gerd Moellmann committed
436 437 438
(defun tooltip-gud-process-output (process output)
  "Process debugger output and show it in a tooltip window."
  (set-process-filter process tooltip-gud-original-filter)
439 440
  (tooltip-show (tooltip-strip-prompt process output)
		tooltip-gud-echo-area))
Gerd Moellmann's avatar
Gerd Moellmann committed
441 442 443 444 445 446

(defun tooltip-gud-print-command (expr)
  "Return a suitable command to print the expression EXPR.
If TOOLTIP-GUD-DEREFERENCE is t, also prepend a `*' to EXPR."
  (when tooltip-gud-dereference
    (setq expr (concat "*" expr)))
447 448
  (case gud-minor-mode
    ((gdb gdba) (concat "server print " expr))
449
    (dbx (concat "print " expr))
Gerd Moellmann's avatar
Gerd Moellmann committed
450 451 452
    (xdb (concat "p " expr))
    (sdb (concat expr "/"))
    (perldb expr)))
Sam Steingold's avatar
Sam Steingold committed
453

Gerd Moellmann's avatar
Gerd Moellmann committed
454
(defun tooltip-gud-tips (event)
455 456 457
  "Show tip for identifier or selection under the mouse.
The mouse must either point at an identifier or inside a selected
region for the tip window to be shown.  If tooltip-gud-dereference is t,
458 459 460
add a `*' in front of the printed expression. In the case of a C program
controlled by GDB, show the associated #define directives when program is
not executing.
Gerd Moellmann's avatar
Gerd Moellmann committed
461 462

This function must return nil if it doesn't handle EVENT."
463
  (let (process)
Gerd Moellmann's avatar
Gerd Moellmann committed
464 465 466
    (when (and (eventp event)
	       tooltip-gud-tips-p
	       (boundp 'gud-comint-buffer)
467 468
	       gud-comint-buffer
	       (buffer-name gud-comint-buffer); gud-comint-buffer might be killed
469
	       (setq process (get-buffer-process gud-comint-buffer))
Gerd Moellmann's avatar
Gerd Moellmann committed
470
	       (posn-point (event-end event))
471 472 473
	       (or (eq gud-minor-mode 'gdba)
		   (progn (setq tooltip-gud-event event)
			  (eval (cons 'and tooltip-gud-display)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
474 475
      (let ((expr (tooltip-expr-to-print event)))
	(when expr
476 477 478 479 480 481 482
	  (if (and (eq gud-minor-mode 'gdba)
		   (not gdb-active-process))
	      (progn
		(with-current-buffer
		    (window-buffer (let ((mouse (mouse-position)))
				     (window-at (cadr mouse)
						(cddr mouse))))
483 484 485 486
		  (let ((define-elt (assoc expr gdb-define-alist)))
		    (unless (null define-elt)
		      (tooltip-show (cdr define-elt))
		      expr))))
487 488 489 490 491 492 493 494 495 496
	    (let ((cmd (tooltip-gud-print-command expr)))
	      (unless (null cmd) ; CMD can be nil if unknown debugger
		(case gud-minor-mode
		  (gdba (gdb-enqueue-input
			 (list  (concat cmd "\n") 'gdb-tooltip-print)))
		  (t
		   (setq tooltip-gud-original-filter (process-filter process))
		   (set-process-filter process 'tooltip-gud-process-output)
	       	  (gud-basic-call cmd)))
		expr))))))))
497 498

(defun gdb-tooltip-print ()
499
  (tooltip-show
500
   (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
501
     (let ((string (buffer-string)))
502
       ;; remove newline for tooltip-gud-echo-area
503 504
       (substring string 0 (- (length string) 1))))
   tooltip-gud-echo-area))
Gerd Moellmann's avatar
Gerd Moellmann committed
505 506 507 508 509 510 511 512 513 514


;;; Tooltip help.

(defvar tooltip-help-message nil
  "The last help message received via `tooltip-show-help-function'.")

(defun tooltip-show-help-function (msg)
  "Function installed as `show-help-function'.
MSG is either a help string to display, or nil to cancel the display."
515
  (let ((previous-help tooltip-help-message))
Gerd Moellmann's avatar
Gerd Moellmann committed
516 517
    (setq tooltip-help-message msg)
    (cond ((null msg)
Gerd Moellmann's avatar
Gerd Moellmann committed
518 519
	   ;; Cancel display.  This also cancels a delayed tip, if
	   ;; there is one.
Gerd Moellmann's avatar
Gerd Moellmann committed
520
	   (tooltip-hide))
Gerd Moellmann's avatar
Gerd Moellmann committed
521 522 523 524
	  ((equal previous-help msg)
	   ;; Same help as before (but possibly the mouse has moved).
	   ;; Keep what we have.
	   )
Gerd Moellmann's avatar
Gerd Moellmann committed
525
	  (t
526
	   ;; A different help.  Remove a previous tooltip, and
Gerd Moellmann's avatar
Gerd Moellmann committed
527 528 529
	   ;; display a new one, with some delay.
	   (tooltip-hide)
	   (tooltip-start-delayed-tip)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532

(defun tooltip-help-tips (event)
  "Hook function to display a help tooltip.
Gerd Moellmann's avatar
Gerd Moellmann committed
533
This is installed on the hook `tooltip-hook', which is run when
Pavel Janík's avatar
Pavel Janík committed
534
the timer with ID `tooltip-timeout-id' fires.
Gerd Moellmann's avatar
Gerd Moellmann committed
535 536
Value is non-nil if this function handled the tip."
  (when (stringp tooltip-help-message)
537
    (tooltip-show tooltip-help-message)
Gerd Moellmann's avatar
Gerd Moellmann committed
538 539
    t))

540
(provide 'tooltip)
Gerd Moellmann's avatar
Gerd Moellmann committed
541

Stefan Monnier's avatar
Stefan Monnier committed
542
;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f
Gerd Moellmann's avatar
Gerd Moellmann committed
543
;;; tooltip.el ends here