1736 |
the text that would appear in a mode line or header line |
the text that would appear in a mode line or header line |
1737 |
based on certain mode-line specification. |
based on certain mode-line specification. |
1738 |
|
|
1739 |
@defun format-mode-line &optional format window no-props buffer |
@defun format-mode-line format &optional window no-props buffer |
1740 |
This function formats a line of text according to @var{format} as if |
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 |
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 |
displaying the text in the mode line or the header line, it returns |
1743 |
the text as a string. |
the text as a string. The argument @var{window} defaults to the |
1744 |
|
selected window. If @var{buffer} is non-@code{nil}, all the |
1745 |
If @var{format} is @code{nil}, that means to use |
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 |
@var{window}'s buffer. |
|
mode line. If @var{format} is @code{t}, that means to use |
|
|
@code{header-line-format} so as to return the text that would appear |
|
|
in the header line (@code{""} if the window has no header line). |
|
|
The argument @var{window} defaults to the selected window. |
|
1747 |
|
|
1748 |
The value string normally has text properties that correspond to the |
The value string normally has text properties that correspond to the |
1749 |
faces, keymaps, etc., that the mode line would have. If |
faces, keymaps, etc., that the mode line would have. If |
1750 |
@var{no-props} is non-@code{nil}, the value has no text properties. |
@var{no-props} is non-@code{nil}, the value has no text properties. |
1751 |
If @var{buffer} is non-@code{nil}, all the information used is taken |
|
1752 |
from @var{buffer}; by default,it comes from @var{window}'s buffer. |
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). |
1755 |
@end defun |
@end defun |
1756 |
|
|
1757 |
@node Imenu |
@node Imenu |