diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2021-11-30 20:07:19 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2021-11-30 20:07:19 +0200 |
| commit | 7433e7457118841b4820cd865fb60b247ba97ef0 (patch) | |
| tree | a3f552efa6e1ecd49ace4d2258407c0ef1a901a1 /doc/lispref/text.texi | |
| parent | a2d98c54f71a8f1c0a1dee32dfcd6c36e5d7c107 (diff) | |
| download | emacs-7433e7457118841b4820cd865fb60b247ba97ef0.tar.gz | |
Improve documentation of pixel-fill
* doc/lispref/text.texi (Filling): Describe the arguments of
'pixel-fill-region'. Add index entry.
* lisp/textmodes/pixel-fill.el (pixel-fill-region): Doc fix.
Diffstat (limited to 'doc/lispref/text.texi')
| -rw-r--r-- | doc/lispref/text.texi | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index ff42ceaf9c6..71540742bac 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -1656,9 +1656,15 @@ Most Emacs buffers use monospaced text, so all the filling functions (like @code{fill-region}) work based on the number of characters and @code{char-width}. However, Emacs can render other types of things, like text that contains images and using proportional fonts, and the -@code{pixel-fill-region} exists to handle that. For instance, this -Lisp snippet will insert text using a proportional font, and then fill -this to be no wider than 300 pixels: +@code{pixel-fill-region} exists to handle that. It fills the region +of text between @var{start} and @var{end} at pixel granularity, so +text using variable-pitch fonts or several different fonts looks +filled regardless of different character sizes. The argument +@var{pixel-width} specifies the maximum pixel width a line is allowed +to have aftder filling; it is the pixel-resolution equivalent of the +@code{fill-column} in @code{fill-region}. For instance, this Lisp +snippet will insert text using a proportional font, and then fill this +to be no wider than 300 pixels: @lisp (insert (propertize @@ -1667,9 +1673,11 @@ this to be no wider than 300 pixels: (pixel-fill-region (point) (point-max) 300) @end lisp -If @var{start} isn't at the start of a line, that pixel position will -be used as the indentation prefix on subsequent lines. +If @var{start} isn't at the start of a line, the horizontal position +of @var{start}, converted to pixel units, will be used as the +indentation prefix on subsequent lines. +@findex pixel-fill-width The @code{pixel-fill-width} helper function can be used to compute the pixel width to use. If given no arguments, it'll return a value slightly less than the width of the current window. The first |