diff options
| author | Paul Eggert | 2016-04-11 09:07:16 -0700 |
|---|---|---|
| committer | Paul Eggert | 2016-04-11 09:07:16 -0700 |
| commit | 435da5d2955ce35be4785b7d46566ed9b42ea9fb (patch) | |
| tree | 581fac64374d0997e53bba0ae3cbd4968fa55121 /doc/lispref | |
| parent | 7c9e6254bbac949aa5493ab1741d2523a7d595b7 (diff) | |
| parent | b134c206bc07dbbb9e74b3be2db269c4f1196e40 (diff) | |
| download | emacs-435da5d2955ce35be4785b7d46566ed9b42ea9fb.tar.gz emacs-435da5d2955ce35be4785b7d46566ed9b42ea9fb.zip | |
Merge from origin/emacs-25
b134c20 Sync with gnulib
bb30fa9 Fix last change on 2016-01-02
488a72f ; Spelling fixes
9b1aab9 Port run-prolog EMACS to SWI-Prolog 7.2.3
0e7bcec Avoid crashes due to unreasonably large or small text scaling
85f257c Improve documentation of 'with-eval-after-load'
668c7bc Improve handling of non-ASCII characters in Git log messages
b570769 Remove undefined behavior in OS X dumper.
97211f3 Fix clipping of xwidgets
e87fbc0 Improve Lisp-level documentation of tooltips
9f1786e Faces names should not end in "-face".
3283271 * src/xsmfns.c (syms_of_xsmfns): Remove stray "s in doc strings.
a1f221b Comint and compile no longer set EMACS
5c28890 * lisp/subr.el (read-key): Don't let the prompt linger (bug#2...
a75b9a6 Merge branch 'emacs-25' of git.savannah.gnu.org:/srv/git/emac...
c93ae7a Allow to customize names of executables used by grep.el
f6497c6 Set locale encoding to UTF-8 when run from OS X GUI.
7ad1d07 Avoid signaling errors in 'M-n' at the 'C-x C-f' prompt
a3f1ac2 Avoid infinite loop in 'studlify-word'
f36df4b Don’t recommend obsolete EMACS env var
fb0b531 * lisp/emacs-lisp/package.el: Change from a few days ago need...
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/display.texi | 76 | ||||
| -rw-r--r-- | doc/lispref/elisp.texi | 1 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 5 |
3 files changed, 79 insertions, 3 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 1e45501482c..3cd1d4edf1c 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -34,6 +34,7 @@ that Emacs presents to the user. | |||
| 34 | * Character Display:: How Emacs displays individual characters. | 34 | * Character Display:: How Emacs displays individual characters. |
| 35 | * Beeping:: Audible signal to the user. | 35 | * Beeping:: Audible signal to the user. |
| 36 | * Window Systems:: Which window system is being used. | 36 | * Window Systems:: Which window system is being used. |
| 37 | * Tooltips:: Tooltip display in Emacs. | ||
| 37 | * Bidirectional Display:: Display of bidirectional scripts, such as | 38 | * Bidirectional Display:: Display of bidirectional scripts, such as |
| 38 | Arabic and Farsi. | 39 | Arabic and Farsi. |
| 39 | @end menu | 40 | @end menu |
| @@ -7131,6 +7132,81 @@ indicator of Emacs capabilities on a given display type. Instead, use | |||
| 7131 | @code{display-graphic-p} or any of the other @code{display-*-p} | 7132 | @code{display-graphic-p} or any of the other @code{display-*-p} |
| 7132 | predicates described in @ref{Display Feature Testing}. | 7133 | predicates described in @ref{Display Feature Testing}. |
| 7133 | 7134 | ||
| 7135 | @node Tooltips | ||
| 7136 | @section Tooltips | ||
| 7137 | @cindex tooltips | ||
| 7138 | @dfn{Tooltips} are special frames (@pxref{Frames}) that are used to | ||
| 7139 | display helpful hints (a.k.a.@: ``tips'') related to the current | ||
| 7140 | position of the mouse pointer. Emacs uses tooltips to display help | ||
| 7141 | strings about active portions of text (@pxref{Special Properties}) and | ||
| 7142 | about various UI elements, such as menu items (@pxref{Extended Menu | ||
| 7143 | Items}) and tool-bar buttons (@pxref{Tool Bar}). | ||
| 7144 | |||
| 7145 | @defun tooltip-mode | ||
| 7146 | Tooltip Mode is a minor mode that enables display of tooltips. | ||
| 7147 | Turning off this mode causes the tooltips be displayed in the echo | ||
| 7148 | area. On text-mode (a.k.a.@: ``TTY'') frames, tooltips are always | ||
| 7149 | displayed in the echo area. | ||
| 7150 | @end defun | ||
| 7151 | |||
| 7152 | @vindex x-gtk-use-system-tooltips | ||
| 7153 | When Emacs is built with GTK+ support, it by default displays tooltips | ||
| 7154 | using GTK+ functions, and the appearance of the tooltips is then | ||
| 7155 | controlled by GTK+ settings. GTK+ tooltips can be disabled by | ||
| 7156 | changing the value of the variable @code{x-gtk-use-system-tooltips} to | ||
| 7157 | @code{nil}. The rest of this subsection describes how to control | ||
| 7158 | non-GTK+ tooltips, which are presented by Emacs itself. | ||
| 7159 | |||
| 7160 | Since tooltips are special frames, they have their frame parameters | ||
| 7161 | (@pxref{Frame Parameters}). Unlike other frames, the frame parameters | ||
| 7162 | for tooltips are stored in a special variable. | ||
| 7163 | |||
| 7164 | @defvar tooltip-frame-parameters | ||
| 7165 | This customizable option holds the frame parameters used for | ||
| 7166 | displaying tooltips. Any font and color parameters are ignored, and | ||
| 7167 | the corresponding attributes of the @code{tooltip} face are used | ||
| 7168 | instead. If @code{left} or @code{top} parameters are included, they | ||
| 7169 | are used as absolute frame-relative coordinates where the tooltip | ||
| 7170 | should be shown. (Mouse-relative position of the tooltip can be | ||
| 7171 | customized using the variables described in @ref{Tooltips,,, emacs, | ||
| 7172 | The GNU Emacs Manual}.) Note that the @code{left} and @code{top} | ||
| 7173 | parameters, if present, override the values of mouse-relative offsets. | ||
| 7174 | @end defvar | ||
| 7175 | |||
| 7176 | @vindex tooltip@r{ face} | ||
| 7177 | The @code{tooltip} face determines the appearance of text shown in | ||
| 7178 | tooltips. It should generally use a variable-pitch font of size that | ||
| 7179 | is preferably smaller than the default frame font. | ||
| 7180 | |||
| 7181 | @findex tooltip-help-tips | ||
| 7182 | @defvar tooltip-functions | ||
| 7183 | This abnormal hook is a list of functions to call when Emacs needs to | ||
| 7184 | display a tooltip. Each function is called with a single argument | ||
| 7185 | @var{event} which is a copy of the last mouse movement event. If a | ||
| 7186 | function on this list actually displays the tooltip, it should return | ||
| 7187 | non-@code{nil}, and then the rest of the functions will not be | ||
| 7188 | called. The default value of this variable is a single function | ||
| 7189 | @code{tooltip-help-tips}. | ||
| 7190 | @end defvar | ||
| 7191 | |||
| 7192 | If you write your own function to be put on the | ||
| 7193 | @code{tooltip-functions} list, you may need to know the buffer of the | ||
| 7194 | mouse event that triggered the tooltip display. The following | ||
| 7195 | function provides that information. | ||
| 7196 | |||
| 7197 | @defun tooltip-event-buffer event | ||
| 7198 | This function returns the buffer over which @var{event} occurred. | ||
| 7199 | Call it with the argument of the function from | ||
| 7200 | @code{tooltip-functions} to obtain the buffer whose text triggered the | ||
| 7201 | tooltip. Note that the event might occur not over a buffer (e.g., | ||
| 7202 | over the tool bar), in which case this function will return | ||
| 7203 | @code{nil}. | ||
| 7204 | @end defun | ||
| 7205 | |||
| 7206 | Other aspects of tooltip display are controlled by several | ||
| 7207 | customizable settings; see @ref{Tooltips,,, emacs, The GNU Emacs | ||
| 7208 | Manual}. | ||
| 7209 | |||
| 7134 | @node Bidirectional Display | 7210 | @node Bidirectional Display |
| 7135 | @section Bidirectional Display | 7211 | @section Bidirectional Display |
| 7136 | @cindex bidirectional display | 7212 | @cindex bidirectional display |
diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index 4c1541e98c6..a3bff0b07ac 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi | |||
| @@ -1380,6 +1380,7 @@ Emacs Display | |||
| 1380 | * Character Display:: How Emacs displays individual characters. | 1380 | * Character Display:: How Emacs displays individual characters. |
| 1381 | * Beeping:: Audible signal to the user. | 1381 | * Beeping:: Audible signal to the user. |
| 1382 | * Window Systems:: Which window system is being used. | 1382 | * Window Systems:: Which window system is being used. |
| 1383 | * Tooltips:: Tooltip display in Emacs. | ||
| 1383 | * Bidirectional Display:: Display of bidirectional scripts, such as | 1384 | * Bidirectional Display:: Display of bidirectional scripts, such as |
| 1384 | Arabic and Farsi. | 1385 | Arabic and Farsi. |
| 1385 | 1386 | ||
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 55f02904fa1..991b47d20b4 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3279,12 +3279,11 @@ or shorter, higher or lower, wider or narrow, or replaced with an image. | |||
| 3279 | 3279 | ||
| 3280 | @item help-echo | 3280 | @item help-echo |
| 3281 | @kindex help-echo @r{(text property)} | 3281 | @kindex help-echo @r{(text property)} |
| 3282 | @cindex tooltip | 3282 | @cindex tooltip for help strings |
| 3283 | @anchor{Text help-echo} | 3283 | @anchor{Text help-echo} |
| 3284 | If text has a string as its @code{help-echo} property, then when you | 3284 | If text has a string as its @code{help-echo} property, then when you |
| 3285 | move the mouse onto that text, Emacs displays that string in the echo | 3285 | move the mouse onto that text, Emacs displays that string in the echo |
| 3286 | area, or in the tooltip window (@pxref{Tooltips,,, emacs, The GNU Emacs | 3286 | area, or in the tooltip window (@pxref{Tooltips}). |
| 3287 | Manual}). | ||
| 3288 | 3287 | ||
| 3289 | If the value of the @code{help-echo} property is a function, that | 3288 | If the value of the @code{help-echo} property is a function, that |
| 3290 | function is called with three arguments, @var{window}, @var{object} and | 3289 | function is called with three arguments, @var{window}, @var{object} and |