]> code.delx.au - gnu-emacs/blobdiff - lisp/time.el
(menu-bar-help-menu): Add menu item for non-English
[gnu-emacs] / lisp / time.el
index 53af0db4c4b997bca2f6f895d23e1697e31cad21..de8b2ce06b53570a0269d23a27ee64cb08835dda 100644 (file)
@@ -1,6 +1,6 @@
-;;; time.el --- display time and load in mode line of Emacs.
+;;; time.el --- display time, load and mail indicator in mode line of Emacs.
 
-;; Copyright (C) 1985, 86, 87, 93, 94, 1996 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 87, 93, 94, 96, 2000 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 
   :group 'mail)
 
 
+;;;###autoload
 (defcustom display-time-mode nil
   "Toggle display of time, load level, and mail flag in mode lines.
-This variable should be set only with \\[customize], which is equivalent
-to using the function `display-time-mode'.
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `display-time-mode'."
   :set (lambda (symbol value)
         (display-time-mode (or value 0)))
   :initialize 'custom-initialize-default
@@ -51,7 +52,8 @@ to using the function `display-time-mode'.
   "*File name of mail inbox file, for indicating existence of new mail.
 Non-nil and not a string means don't check for mail.  nil means use
 default, which is system-dependent, and is the same as used by Rmail."
-  :type '(choice (const :tag "Default" nil)
+  :type '(choice (const :tag "(None)" none)
+                (const :tag "Default" nil)
                 (file :format "%v"))
   :group 'display-time)
 
@@ -130,6 +132,28 @@ This runs the normal hook `display-time-hook' after each update."
       (remove-hook 'rmail-after-get-new-mail-hook
                   'display-time-event-handler))))
 
+(defcustom display-time-mail-face 'mode-line
+  "Face to use for `display-time-mail-string'.
+If `display-time-use-mail-icon' is non-nil, the image's background
+colour is the background of this face.  Set this to a face other than
+`mode-line' to make the mail indicator stand out on a suitable
+display."
+  :group 'faces
+  :group 'display-time
+  :type 'face)
+
+(defvar display-time-mail-icon
+  (find-image '((:type xbm :file "letter.xbm" :ascent center)))
+  "Image specification to offer as the mail indicator on a graphic
+display.  See `display-time-use-mail-icon' and
+`display-time-mail-face'.")
+
+(defcustom display-time-use-mail-icon nil
+  "Non-nil means use an icon as the mail indicator on a graphic display.
+Otherwise use the string \"Mail\".  The icon may consume less of the
+mode line.  It is specified by `display-time-mail-icon'."
+  :group 'display-time
+  :type 'boolean)
 
 (defcustom display-time-format nil
   "*A string specifying the format for displaying the time in the mode line.
@@ -148,7 +172,20 @@ depend on `display-time-day-and-date' and `display-time-24hr-format'."
                            (if display-time-24hr-format "%H:%M" "%-I:%M%p"))
                        now)
     load
-    (if mail " Mail" ""))
+    (if mail
+       ;; Build the string every time to act on customization.
+       (concat " "
+               (propertize
+                "Mail"
+                'display `(when (and display-time-use-mail-icon
+                                     (display-graphic-p))
+                            ,@display-time-mail-icon
+                            ,@(list :background (face-attribute
+                                                 display-time-mail-face
+                                                 :background)))
+                'help-echo "mouse-2: Read mail"
+                'local-map (make-mode-line-mouse2-map read-mail-command)))
+      ""))
   "*A list of expressions governing display of the time in the mode line.
 For most purposes, you can control the time format using `display-time-format'
 which is a more standard interface.
@@ -203,8 +240,12 @@ would give mode line times like `94/12/30 21:07:48 (UTC)'."
         (time (current-time-string now))
          (load (condition-case ()
                    (if (zerop (car (load-average))) ""
+                    ;; The load average number is mysterious, so
+                    ;; propvide some help.
                      (let ((str (format " %03d" (car (load-average)))))
-                       (concat (substring str 0 -2) "." (substring str -2))))
+                      (propertize
+                       (concat (substring str 0 -2) "." (substring str -2))
+                       'help-echo "System load average")))
                  (error "")))
          (mail-spool-file (or display-time-mail-file
                               (getenv "MAIL")
@@ -213,9 +254,11 @@ would give mode line times like `94/12/30 21:07:48 (UTC)'."
         (mail (and (stringp mail-spool-file)
                    (or (null display-time-server-down-time)
                        ;; If have been down for 20 min, try again.
-                       (> (- (nth 1 (current-time))
-                             display-time-server-down-time)
-                          1200))
+                       (> (- (nth 1 now) display-time-server-down-time)
+                          1200)
+                       (and (< (nth 1 now) display-time-server-down-time)
+                            (> (- (nth 1 now) display-time-server-down-time)
+                               -64336)))
                    (let ((start-time (current-time)))
                      (prog1
                          (display-time-file-nonempty-p mail-spool-file)