Mercurial > emacs
changeset 59138:2602d3e5fec0
(Emulating Mode Line): Document format's BUFFER arg.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 27 Dec 2004 16:58:07 +0000 |
| parents | d7025bc399f1 |
| children | e95aeb133905 |
| files | lispref/modes.texi |
| diffstat | 1 files changed, 3 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/modes.texi Mon Dec 27 16:57:31 2004 +0000 +++ b/lispref/modes.texi Mon Dec 27 16:58:07 2004 +0000 @@ -1736,7 +1736,7 @@ the text that would appear in a mode line or header line based on certain mode-line specification. -@defun format-mode-line &optional format window no-props +@defun format-mode-line &optional format window no-props buffer This function formats a line of text according to @var{format} as if it were generating the mode line for @var{window}, but instead of displaying the text in the mode line or the header line, it returns @@ -1752,6 +1752,8 @@ The value string normally has text properties that correspond to the faces, keymaps, etc., that the mode line would have. If @var{no-props} is non-@code{nil}, the value has no text properties. +If @var{buffer} is non-@code{nil}, all the information used is taken +from @var{buffer}; by default,it comes from @var{window}'s buffer. @end defun @node Imenu