]> code.delx.au - gnu-emacs/blobdiff - lisp/tooltip.el
Make `buffer-offer-save' permanently local
[gnu-emacs] / lisp / tooltip.el
index cf1951bedb8a1d85239b895a10d20e251b6a0eaa..bfe53dc71b75d525a0b4f0f0e48ed3766acf7537 100644 (file)
@@ -1,10 +1,10 @@
 ;;; tooltip.el --- show tooltip windows
 
-;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1999-2011 Free Software Foundation, Inc.
 
 ;; Author: Gerd Moellmann <gerd@acm.org>
 ;; Keywords: help c mouse tools
+;; Package: emacs
 
 ;; This file is part of GNU Emacs.
 
@@ -52,7 +52,7 @@ the help text in the echo area, and does not make a pop-up window."
   ;; Even if we start on a text-only terminal, make this non-nil by
   ;; default because we can open a graphical frame later (multi-tty).
   :init-value t
-  :initialize 'custom-initialize-safe-default
+  :initialize 'custom-initialize-delay
   :group 'tooltip
   (unless (or (null tooltip-mode) (fboundp 'x-show-tip))
     (error "Sorry, tooltips are not yet available on this system"))
@@ -198,7 +198,7 @@ This might return nil if the event did not occur over a buffer."
   (setq tooltip-timeout-id
        (add-timeout (tooltip-delay) 'tooltip-timeout nil)))
 
-(defun tooltip-timeout (object)
+(defun tooltip-timeout (_object)
   "Function called when timer with id `tooltip-timeout-id' fires."
   (run-hook-with-args-until-success 'tooltip-functions
                                    tooltip-last-mouse-motion-event))
@@ -256,7 +256,7 @@ in echo area."
 
 (declare-function x-hide-tip "xfns.c" ())
 
-(defun tooltip-hide (&optional ignored-arg)
+(defun tooltip-hide (&optional _ignored-arg)
   "Hide a tooltip, if one is displayed.
 Value is non-nil if tooltip was open."
   (tooltip-cancel-delayed-tip)
@@ -319,25 +319,31 @@ the buffer of PROCESS."
 ;;; Tooltip help.
 
 (defvar tooltip-help-message nil
-  "The last help message received via `tooltip-show-help'.")
+  "The last help message received via `show-help-function'.
+This is used by `tooltip-show-help' and
+`tooltip-show-help-non-mode'.")
 
 (defvar tooltip-previous-message nil
   "The previous content of the echo area.")
 
 (defun tooltip-show-help-non-mode (help)
-  "Function installed as `show-help-function' when tooltip is off."
+  "Function installed as `show-help-function' when Tooltip mode is off.
+It is also called if Tooltip mode is on, for text-only displays."
   (when (and (not (window-minibuffer-p)) ;Don't overwrite minibuffer contents.
-             ;; Don't know how to reproduce it in Elisp:
-             ;; Don't overwrite a keystroke echo.
-             ;; (NILP (echo_message_buffer) || ok_to_overwrite_keystroke_echo)
-             (not cursor-in-echo-area)) ;Don't overwrite a prompt.
+             (not cursor-in-echo-area))  ;Don't overwrite a prompt.
     (cond
      ((stringp help)
-      (unless tooltip-previous-message
+      (setq help (replace-regexp-in-string "\n" ", " help))
+      (unless (or tooltip-previous-message
+                 (string-equal help (current-message))
+                 (and (stringp tooltip-help-message)
+                      (string-equal tooltip-help-message
+                                    (current-message))))
         (setq tooltip-previous-message (current-message)))
+      (setq tooltip-help-message help)
       (let ((message-truncate-lines t)
             (message-log-max nil))
-        (message "%s" (replace-regexp-in-string "\n" ", " help))))
+        (message "%s" help)))
      ((stringp tooltip-previous-message)
       (let ((message-log-max nil))
         (message "%s" tooltip-previous-message)
@@ -348,23 +354,26 @@ the buffer of PROCESS."
 (defun tooltip-show-help (msg)
   "Function installed as `show-help-function'.
 MSG is either a help string to display, or nil to cancel the display."
-  (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))
-         ((equal previous-help msg)
-          ;; Same help as before (but possibly the mouse has moved).
-          ;; Keep what we have.
-          )
-         (t
-          ;; 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)
+  (if (display-graphic-p)
+      (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))
+             ((equal previous-help msg)
+              ;; Same help as before (but possibly the mouse has moved).
+              ;; Keep what we have.
+              )
+             (t
+              ;; A different help.  Remove a previous tooltip, and
+              ;; display a new one, with some delay.
+              (tooltip-hide)
+              (tooltip-start-delayed-tip))))
+    ;; On text-only displays, try `tooltip-show-help-non-mode'.
+    (tooltip-show-help-non-mode msg)))
+
+(defun tooltip-help-tips (_event)
   "Hook function to display a help tooltip.
 This is installed on the hook `tooltip-functions', which
 is run when the timer with id `tooltip-timeout-id' fires.
@@ -375,5 +384,4 @@ Value is non-nil if this function handled the tip."
 
 (provide 'tooltip)
 
-;; arch-tag: 3d61135e-4618-4a78-af28-183f6df5636f
 ;;; tooltip.el ends here