Variable: calendar-date-echo-text

calendar-date-echo-text is a customizable variable defined in calendar.el.gz.

Value

"mouse-2: general menu\nmouse-3: menu for this date"

Documentation

String displayed when the cursor is over a date in the calendar.

Can be either a fixed string, or a Lisp expression that returns one. When this expression is evaluated, DAY, MONTH, and YEAR are integers appropriate to the relevant date. For example, to display the ISO date:

  (setq calendar-date-echo-text '(format "ISO date: %s"
                                         (calendar-iso-date-string
                                          (list month day year))))

Changing this variable without using customize has no effect on pre-existing calendar windows.

This variable was added, or its default value changed, in Emacs 23.1.

Source Code

;; Defined in /usr/src/emacs/lisp/calendar/calendar.el.gz
(defcustom calendar-date-echo-text
  "mouse-2: general menu\nmouse-3: menu for this date"
  "String displayed when the cursor is over a date in the calendar.
Can be either a fixed string, or a Lisp expression that returns one.
When this expression is evaluated, DAY, MONTH, and YEAR are
integers appropriate to the relevant date.  For example, to
display the ISO date:

  (setq calendar-date-echo-text \\='(format \"ISO date: %s\"
                                         (calendar-iso-date-string
                                          (list month day year))))

Changing this variable without using customize has no effect on
pre-existing calendar windows."
  :group 'calendar
  :initialize 'custom-initialize-default
  :risky t
  :set (lambda (sym val)
         (set sym val)
         (calendar-redraw))
  :type '(choice (string :tag "Fixed string")
                 (sexp :value
                       (format "ISO date: %s"
                                (calendar-iso-date-string
                                 (list month day year)))))
  :version "23.1")