diff options
author | Eli Zaretskii <eliz@gnu.org> | 2016-04-09 12:30:59 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2016-04-09 12:30:59 +0300 |
commit | e87fbc07801a4ac291d335f0af957ca32cd26381 (patch) | |
tree | ee860dec60f8b944ae6be93ab71c5e74df166131 /doc/emacs | |
parent | 9f1786e4165aba30ddb16116c5557a0531233008 (diff) | |
download | emacs-e87fbc07801a4ac291d335f0af957ca32cd26381.tar.gz |
Improve Lisp-level documentation of tooltips
* doc/lispref/display.texi (Tooltips): New section. (Bug#23246)
(Display): Update the chapter menu.
* doc/lispref/text.texi (Special Properties): Make the "tooltip"
index entry more concrete. Change the cross-reference to point to
"Tooltips" in the ELisp manual.
* doc/lispref/elisp.texi (Top): Update the master menu.
* doc/emacs/frames.texi (Tooltips): Include more customization
variables. Add a cross-reference to the ELisp manual.
Diffstat (limited to 'doc/emacs')
-rw-r--r-- | doc/emacs/frames.texi | 50 |
1 files changed, 40 insertions, 10 deletions
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index 35b3f83ab33..383ae7fd6ee 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -1152,11 +1152,11 @@ change the variable @code{x-gtk-file-dialog-help-text} to @code{nil}. @section Tooltips @cindex tooltips - @dfn{Tooltips} are small windows that display text information at -the current mouse position. They activate when there is a pause in -mouse movement over some significant piece of text in a window, or the -mode line, or some other part of the Emacs frame such as a tool bar -button or menu item. + @dfn{Tooltips} are small special frames that display text +information at the current mouse position. They activate when there +is a pause in mouse movement over some significant piece of text in a +window, or the mode line, or some other part of the Emacs frame such +as a tool bar button or menu item. @findex tooltip-mode You can toggle the use of tooltips with the command @kbd{M-x @@ -1164,11 +1164,41 @@ tooltip-mode}. When Tooltip mode is disabled, the help text is displayed in the echo area instead. To control the use of tooltips at startup, customize the variable @code{tooltip-mode}. -@vindex tooltip-delay - The variables @code{tooltip-delay} specifies how long Emacs should -wait before displaying a tooltip. For additional customization -options for displaying tooltips, use @kbd{M-x customize-group -@key{RET} tooltip @key{RET}}. +The following variables provide customization options for tooltip +display: + +@vtable @code +@item tooltip-delay +This variable specifies how long Emacs should wait before displaying +the first tooltip. The value is in seconds. + +@item tooltip-short-delay +This variable specifies how long Emacs should wait before displaying +subsequent tooltips on different items, having already displayed the +first tooltip. The value is in seconds. + +@item tooltip-hide-delay +The number of seconds since displaying a tooltip to hide it, if the +mouse doesn't move. + +@item tooltip-x-offset +@itemx tooltip-y-offset +The X and Y offsets, in pixels, of the left top corner of the tooltip +from the mouse pointer position. Note that these are ignored if +@code{tooltip-frame-parameters} was customized to include, +respectively, the @code{left} and @code{top} parameters. The values +of the offsets should be chosen so that the tooltip doesn't cover the +mouse pointer's hot spot, or it might interfere with clicking the +mouse. + +@item tooltip-frame-parameters +The frame parameters used for displaying tooltips. @xref{Frame +Parameters,,, elisp, The Emacs Lisp Reference Manual}, and also +@ref{Tooltips,,, elisp, The Emacs Lisp Reference Manual}. +@end vtable + +For additional customization options for displaying tooltips, use +@kbd{M-x customize-group @key{RET} tooltip @key{RET}}. @vindex x-gtk-use-system-tooltips If Emacs is built with GTK+ support, it displays tooltips via GTK+, |