procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of pixel-fill

Browse source 
* 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.
This commit is contained in:
Eli Zaretskii 2021-11-30 20:07:19 +02:00
parent a2d98c54f7
commit 7433e74571
2 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/lispref/text.texi
View file

@ -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

5
lisp/textmodes/pixel-fill.el
View file

@ -70,8 +70,9 @@ If WINDOW is nil, this defaults to the current window."
This will attempt to reformat the text in the region to have no
lines that are visually wider than PIXEL-WIDTH.
If START isn't at the start of a line, that pixel position will
be used as the indentation prefix on subsequent lines."
If START isn't at the start of a line, the horizontal position of
START, converted to pixel units, will be used as the indentation
prefix on subsequent lines."
(save-excursion
(goto-char start)
(let ((indentation