diff options
| author | Richard M. Stallman <rms@gnu.org> | 2004-12-27 16:58:07 +0000 |
|---|---|---|
| committer | Richard M. Stallman <rms@gnu.org> | 2004-12-27 16:58:07 +0000 |
| commit | 4ac594cd846d2750ac85d0f7edff775d5f5a363d (patch) | |
| tree | 2a29df42d9c771f5dba02d1d87318e52b49e8d45 /lispref | |
| parent | af046edf912f36f420eb52453f3c2bab719272d6 (diff) | |
| download | emacs-4ac594cd846d2750ac85d0f7edff775d5f5a363d.tar.gz | |
(Emulating Mode Line): Document format's BUFFER arg.
Diffstat (limited to 'lispref')
| -rw-r--r-- | lispref/modes.texi | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lispref/modes.texi b/lispref/modes.texi index 01958873d33..2abb8a9c0d9 100644 --- a/lispref/modes.texi +++ b/lispref/modes.texi @@ -1736,7 +1736,7 @@ It is normally @code{nil}, so that ordinary buffers have no header line. 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 argument @var{window} defaults to the selected window. 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 |