;;; tooltip.el --- Show tooltip windows
-;; Copyright (C) 1997, 1999, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1999, 2000, 2001 Free Software Foundation, Inc.
;; Author: Gerd Moellmann <gerd@acm.org>
;; Keywords: help c mouse tools
(defgroup tooltip nil
"Customization group for the `tooltip' package."
:group 'help
- :group 'c
+ :group 'gud
:group 'mouse
:group 'tools
:version "21.1"
:group 'tooltip)
+(defcustom tooltip-hide-delay 5
+ "Hide tooltips automatically after this many seconds."
+ :tag "Hide delay"
+ :type 'number
+ :group 'tooltip)
+
+
+(defcustom tooltip-x-offset nil
+ "Specify an X offset for the display of tooltips.
+The offset is relative to the position of the mouse. It must
+be chosen so that the tooltip window doesn't contain the mouse
+when it pops up."
+ :tag "X offset"
+ :type '(choice (const :tag "Default" nil)
+ (integer :tag "Offset" :value 1))
+ :group 'tooltip)
+
+
+(defcustom tooltip-y-offset nil
+ "Specify an Y offset for the display of tooltips.
+The offset is relative to the position of the mouse. It must
+be chosen so that the tooltip window doesn't contain the mouse
+when it pops up."
+ :tag "Y offset"
+ :type '(choice (const :tag "Default" nil)
+ (integer :tag "Offset" :value 1))
+ :group 'tooltip)
+
+
(defcustom tooltip-frame-parameters
'((name . "tooltip")
- (foreground-color . "black")
- (background-color . "lightyellow")
(internal-border-width . 5)
- (border-color . "lightyellow")
(border-width . 1))
"Frame parameters used for tooltips."
:type 'sexp
:group 'tooltip)
+(defface tooltip
+ '((((class color))
+ (:background "lightyellow" :foreground "black"))
+ (t ()))
+ "Face for tooltips."
+ :group 'tooltip)
+
+
(defcustom tooltip-gud-tips-p nil
"*Non-nil means show tooltips in GUD sessions."
:type 'boolean
(defcustom tooltip-use-echo-area nil
- "Use the echo area instead of the actual tooltip windows."
+ "Use the echo area instead of tooltip frames.
+This is only relevant GUD display, since otherwise it is equivalent to
+turning off Tooltip mode."
:type 'boolean
- :tag "use echo area"
+ :tag "Use echo area"
:group 'tooltip)
\f
"Mode for tooltip display.
With ARG, turn tooltip mode on if and only if ARG is positive."
(interactive "P")
+ (unless (fboundp 'x-show-tip)
+ (error "Sorry, tooltips are not yet available on this system"))
(let* ((on (if arg
(> (prefix-numeric-value arg) 0)
(not tooltip-mode)))
delay))
-(defun tooltip-disable-timeout ()
+(defun tooltip-cancel-delayed-tip ()
"Disable the tooltip timeout."
(when tooltip-timeout-id
(disable-timeout tooltip-timeout-id)
(setq tooltip-timeout-id nil)))
-(defun tooltip-add-timeout ()
+(defun tooltip-start-delayed-tip ()
"Add a one-shot timeout to call function tooltip-timeout."
(setq tooltip-timeout-id
(add-timeout (tooltip-delay) 'tooltip-timeout nil)))
(tooltip-hide)
(when (car (mouse-pixel-position))
(setq tooltip-last-mouse-motion-event (copy-sequence event))
- (tooltip-add-timeout)))
+ (tooltip-start-delayed-tip)))
\f
;;; Displaying tips
+(defun tooltip-set-param (alist key value)
+ "Change the value of KEY in alist ALIAS to VALUE.
+If there's no association for KEY in ALIST, add one, otherwise
+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))
+
+
(defun tooltip-show (text)
"Show a tooltip window at the current mouse position displaying TEXT."
(if tooltip-use-echo-area
(message "%s" text)
- (x-show-tip text (selected-frame) tooltip-frame-parameters)))
+ (condition-case error
+ (let ((params (copy-sequence tooltip-frame-parameters))
+ (fg (face-attribute 'tooltip :foreground))
+ (bg (face-attribute 'tooltip :background)))
+ (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)))
+ (x-show-tip (propertize text 'face 'tooltip)
+ (selected-frame)
+ params
+ tooltip-hide-delay
+ tooltip-x-offset
+ tooltip-y-offset))
+ (error
+ (message "Error while displaying tooltip: %s" error)
+ (sit-for 1)
+ (message "%s" text)))))
+
(defun tooltip-hide (&optional ignored-arg)
"Hide a tooltip, if one is displayed.
Value is non-nil if tooltip was open."
- (tooltip-disable-timeout)
+ (tooltip-cancel-delayed-tip)
(when (x-hide-tip)
(setq tooltip-hide-time (float-time))))
(let ((previous-help tooltip-help-message))
(setq tooltip-help-message msg)
(cond ((null msg)
+ ;; Cancel display. This also cancels a delayed tip, if
+ ;; there is one.
(tooltip-hide))
- ((or (not (stringp previous-help))
- (not (string= msg previous-help)))
- (tooltip-hide)
- (tooltip-add-timeout))
+ ((equal previous-help msg)
+ ;; Same help as before (but possibly the mouse has moved).
+ ;; Keep what we have.
+ )
(t
- (tooltip-disable-timeout)
- (tooltip-add-timeout)))))
+ ;; A different help. Remove a previous tooltip, and
+ ;; display a new one, with some delay.
+ (tooltip-hide)
+ (tooltip-start-delayed-tip)))))
(defun tooltip-help-tips (event)
"Hook function to display a help tooltip.
+This is installed on the hook `tooltip-hook', which is run when
+the the timer with ID `tooltip-timeout-id' fires.
Value is non-nil if this function handled the tip."
(when (stringp tooltip-help-message)
(tooltip-show tooltip-help-message)
- (setq tooltip-help-message nil)
t))
HCoop / bpt / emacs.git / blobdiff