diff options
| author | Richard M. Stallman | 2005-01-06 17:42:58 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-01-06 17:42:58 +0000 |
| commit | 0a54d76e113c13b31fc61ee86781d5c8e077876d (patch) | |
| tree | 60892e3157c65e668747680e90e56e521f2e95f8 | |
| parent | b49018ff4e7a51c9b41a1c37837d7aec85a1eb3a (diff) | |
| download | emacs-0a54d76e113c13b31fc61ee86781d5c8e077876d.tar.gz emacs-0a54d76e113c13b31fc61ee86781d5c8e077876d.zip | |
(Emulating Mode Line): format-mode-line requires 1 arg.
| -rw-r--r-- | lispref/modes.texi | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/lispref/modes.texi b/lispref/modes.texi index 2abb8a9c0d9..299579a10af 100644 --- a/lispref/modes.texi +++ b/lispref/modes.texi | |||
| @@ -1736,24 +1736,22 @@ 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 buffer | 1739 | @defun format-mode-line format &optional 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 |
| 1743 | the text as a string. | 1743 | the text as a string. The argument @var{window} defaults to the |
| 1744 | 1744 | selected window. If @var{buffer} is non-@code{nil}, all the | |
| 1745 | If @var{format} is @code{nil}, that means to use | 1745 | information used is taken from @var{buffer}; by default, it comes from |
| 1746 | @code{mode-line-format} and return the text that would appear in the | 1746 | @var{window}'s buffer. |
| 1747 | mode line. If @var{format} is @code{t}, that means to use | ||
| 1748 | @code{header-line-format} so as to return the text that would appear | ||
| 1749 | in the header line (@code{""} if the window has no header line). | ||
| 1750 | The argument @var{window} defaults to the selected window. | ||
| 1751 | 1747 | ||
| 1752 | The value string normally has text properties that correspond to the | 1748 | The value string normally has text properties that correspond to the |
| 1753 | faces, keymaps, etc., that the mode line would have. If | 1749 | faces, keymaps, etc., that the mode line would have. If |
| 1754 | @var{no-props} is non-@code{nil}, the value has no text properties. | 1750 | @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 | 1751 | |
| 1756 | from @var{buffer}; by default,it comes from @var{window}'s buffer. | 1752 | For example, @code{(format-mode-line header-line-format)} returns the |
| 1753 | text that would appear in the selected window's header line (@code{""} | ||
| 1754 | if it has no header line). | ||
| 1757 | @end defun | 1755 | @end defun |
| 1758 | 1756 | ||
| 1759 | @node Imenu | 1757 | @node Imenu |