diff options
| author | Richard M. Stallman | 2004-12-27 16:58:07 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2004-12-27 16:58:07 +0000 |
| commit | 4ac594cd846d2750ac85d0f7edff775d5f5a363d (patch) | |
| tree | 2a29df42d9c771f5dba02d1d87318e52b49e8d45 | |
| parent | af046edf912f36f420eb52453f3c2bab719272d6 (diff) | |
| download | emacs-4ac594cd846d2750ac85d0f7edff775d5f5a363d.tar.gz emacs-4ac594cd846d2750ac85d0f7edff775d5f5a363d.zip | |
(Emulating Mode Line): Document format's BUFFER arg.
| -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. | |||
| 1736 | the text that would appear in a mode line or header line | 1736 | the text that would appear in a mode line or header line |
| 1737 | based on certain mode-line specification. | 1737 | based on certain mode-line specification. |
| 1738 | 1738 | ||
| 1739 | @defun format-mode-line &optional format window no-props | 1739 | @defun format-mode-line &optional format window no-props buffer |
| 1740 | This function formats a line of text according to @var{format} as if | 1740 | This function formats a line of text according to @var{format} as if |
| 1741 | it were generating the mode line for @var{window}, but instead of | 1741 | it were generating the mode line for @var{window}, but instead of |
| 1742 | displaying the text in the mode line or the header line, it returns | 1742 | 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. | |||
| 1752 | The value string normally has text properties that correspond to the | 1752 | The value string normally has text properties that correspond to the |
| 1753 | faces, keymaps, etc., that the mode line would have. If | 1753 | faces, keymaps, etc., that the mode line would have. If |
| 1754 | @var{no-props} is non-@code{nil}, the value has no text properties. | 1754 | @var{no-props} is non-@code{nil}, the value has no text properties. |
| 1755 | If @var{buffer} is non-@code{nil}, all the information used is taken | ||
| 1756 | from @var{buffer}; by default,it comes from @var{window}'s buffer. | ||
| 1755 | @end defun | 1757 | @end defun |
| 1756 | 1758 | ||
| 1757 | @node Imenu | 1759 | @node Imenu |