]> git.eshelyaron.com Git - emacs.git/commitdiff
; Minor improvements to earlier change
authorPo Lu <luangruo@yahoo.com>
Fri, 13 May 2022 12:48:46 +0000 (20:48 +0800)
committerPo Lu <luangruo@yahoo.com>
Fri, 13 May 2022 12:48:58 +0000 (20:48 +0800)
* etc/NEWS:
* lisp/tooltip.el (tooltip-show): Rename `frame-face' to
`default-face' and improve doc about system tooltips.

etc/NEWS
lisp/tooltip.el

index a67e136643b4c927acd9bf50f9608aa81c173c12..d93a79ed3691bbfb7f9b1e6ec4fa70b34ca2f4f0 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2031,7 +2031,7 @@ Use 'buffer-match-p' to gather a list of buffers that match a
 condition.
 
 ---
-** New arguments 'text-face' and 'frame-face' for 'tooltip-show'.
+** New arguments 'text-face' and 'default-face' for 'tooltip-show'.
 They allow changing the faces used for the tooltip text and frame
 colors of the resulting tooltip frame from the default 'tooltip' face.
 
index 0e7d333f974558983e6cfac59d69e4a4e67e17cc..3e9c16a445a14094182e7811925186486a36aedc 100644 (file)
@@ -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))