summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPo Lu <luangruo@yahoo.com>2021-12-18 20:58:44 +0800
committerPo Lu <luangruo@yahoo.com>2021-12-18 20:58:44 +0800
commit4ff3a70153ac1716bf0767fbbf92b04fdb3b1c80 (patch)
treee89cdddc6e7a923bb99998f75ed974883f002272 /doc
parent7ab1b71c0dd878daa6806ce3a01d429dc5af646c (diff)
parent4544651b3f62ce4a104a058e8c6aee42c23b76bc (diff)
downloademacs-4ff3a70153ac1716bf0767fbbf92b04fdb3b1c80.tar.gz
Merge remote-tracking branch 'origin/master' into feature/pgtk
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/display.texi8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index dd996fbe4a8..98a15404f91 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -2086,7 +2086,7 @@ displayed in a given window. This function is used by
(@pxref{Resizing Windows}) to make a window exactly as large as the text
it contains.
-@defun window-text-pixel-size &optional window from to x-limit y-limit mode-lines
+@defun window-text-pixel-size &optional window from to x-limit y-limit mode-lines ignore-line-at-end
This function returns the size of the text of @var{window}'s buffer in
pixels. @var{window} must be a live window and defaults to the
selected one. The return value is a cons of the maximum pixel-width
@@ -2136,6 +2136,12 @@ line, if present, in the return value. If it is @code{t}, include the
height of all of these lines, if present, in the return value.
@end defun
+The optional argument @var{ignore-line-at-end} controls whether or
+not to count the height of text in @var{to}'s screen line as part of
+the returned pixel-height. This is useful if your Lisp program is
+only interested in the dimensions of text up to and excluding the
+visual beginning of @var{to}'s screen line.
+
@code{window-text-pixel-size} treats the text displayed in a window as a
whole and does not care about the size of individual lines. The
following function does.