diff options
author | Po Lu <luangruo@yahoo.com> | 2022-05-13 20:48:46 +0800 |
---|---|---|
committer | Po Lu <luangruo@yahoo.com> | 2022-05-13 20:48:58 +0800 |
commit | 784a3bde24be0637646ad0bf22f695c84b8e3e05 (patch) | |
tree | b58315f4734a35faec1b9c73cece2e1e074726e1 /lisp/tooltip.el | |
parent | 39e9665127a2cc26f4943c6836323da56879b5d9 (diff) | |
download | emacs-784a3bde24be0637646ad0bf22f695c84b8e3e05.tar.gz |
; Minor improvements to earlier change
* etc/NEWS:
* lisp/tooltip.el (tooltip-show): Rename `frame-face' to
`default-face' and improve doc about system tooltips.
Diffstat (limited to 'lisp/tooltip.el')
-rw-r--r-- | lisp/tooltip.el | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/lisp/tooltip.el b/lisp/tooltip.el index 0e7d333f974..3e9c16a445a 100644 --- a/lisp/tooltip.el +++ b/lisp/tooltip.el @@ -230,16 +230,16 @@ change the existing association. Value is the resulting alist." (declare-function x-show-tip "xfns.c" (string &optional frame parms timeout dx dy)) -(defun tooltip-show (text &optional use-echo-area text-face frame-face) +(defun tooltip-show (text &optional use-echo-area text-face default-face) "Show a tooltip window displaying TEXT. Text larger than `x-max-tooltip-size' is clipped. -If the alist in `tooltip-frame-parameters' includes `left' and `top' -parameters, they determine the x and y position where the tooltip -is displayed. Otherwise, the tooltip pops at offsets specified by -`tooltip-x-offset' and `tooltip-y-offset' from the current mouse -position. +If the alist in `tooltip-frame-parameters' includes `left' and +`top' parameters, they determine the x and y position where the +tooltip is displayed. Otherwise, the tooltip pops at offsets +specified by `tooltip-x-offset' and `tooltip-y-offset' from the +current mouse position. The text properties of TEXT are also modified to add the appropriate faces before displaying the tooltip. If your code @@ -249,21 +249,23 @@ passing it to this function. Optional second arg USE-ECHO-AREA non-nil means to show tooltip in echo area. -The third and fourth args TEXT-FACE and FRAME-FACE specify faces -used to display the tooltip, and default to `tooltip' if not -specified. TEXT-FACE specifies a face used to display text in -the tooltip, while FRAME-FACE specifies a face that provides the -background, foreground and border colors of the tooltip frame. +The third and fourth args TEXT-FACE and DEFAULT-FACE specify +faces used to display the tooltip, and default to `tooltip' if +not specified. TEXT-FACE specifies a face used to display text +in the tooltip, while DEFAULT-FACE specifies a face that provides +the background, foreground and border colors of the tooltip +frame. Note that the last two arguments are not respected when `use-system-tooltips' is non-nil and Emacs is built with support -for system tooltips." +for system tooltips, such as on NS, Haiku, and with the GTK +toolkit." (if use-echo-area (tooltip-show-help-non-mode text) (condition-case error (let ((params (copy-sequence tooltip-frame-parameters)) - (fg (face-attribute (or frame-face 'tooltip) :foreground)) - (bg (face-attribute (or frame-face 'tooltip) :background))) + (fg (face-attribute (or default-face 'tooltip) :foreground)) + (bg (face-attribute (or default-face 'tooltip) :background))) (when (stringp fg) (setf (alist-get 'foreground-color params) fg) (setf (alist-get 'border-color params) fg)) |