diff options
| author | Kim F. Storm | 2005-01-13 09:39:32 +0000 |
|---|---|---|
| committer | Kim F. Storm | 2005-01-13 09:39:32 +0000 |
| commit | f2dfc8562962fe0e1bcf31260238348665937c4c (patch) | |
| tree | e1ef789496e369c08c6852ef46286d47545dde01 | |
| parent | f75a592e8a32362c5dde4fc5d0d2db0dc4969f65 (diff) | |
| download | emacs-f2dfc8562962fe0e1bcf31260238348665937c4c.tar.gz emacs-f2dfc8562962fe0e1bcf31260238348665937c4c.zip | |
(Emulating Mode Line): Update format-mode-line entry.
| -rw-r--r-- | lispref/modes.texi | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/lispref/modes.texi b/lispref/modes.texi index ebedbc520b8..24cf95d6985 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 format &optional window no-props buffer face | 1739 | @defun format-mode-line format &optional face window 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,13 +1752,12 @@ value which is usually @var{face}. (If @var{face} is @code{t}, | |||
| 1752 | that stands for either @code{mode-line} if @var{window} is selected, | 1752 | that stands for either @code{mode-line} if @var{window} is selected, |
| 1753 | otherwise @code{mode-line-inactive}.) | 1753 | otherwise @code{mode-line-inactive}.) |
| 1754 | 1754 | ||
| 1755 | However, if @var{no-props} is non-@code{nil}, the value has no text | 1755 | However, if @var{face} is an integer, the value has no text properties. |
| 1756 | properties. | ||
| 1757 | 1756 | ||
| 1758 | For example, @code{(format-mode-line header-line-format)} returns the | 1757 | For example, @code{(format-mode-line header-line-format)} returns the |
| 1759 | text that would appear in the selected window's header line (@code{""} | 1758 | text that would appear in the selected window's header line (@code{""} |
| 1760 | if it has no header line). @code{(format-mode-line header-line-format | 1759 | if it has no header line). @code{(format-mode-line header-line-format |
| 1761 | nil nil nil 'header-line)} returns the same text, with each character | 1760 | 'header-line)} returns the same text, with each character |
| 1762 | carrying the face that it will have in the header line itself. | 1761 | carrying the face that it will have in the header line itself. |
| 1763 | @end defun | 1762 | @end defun |
| 1764 | 1763 | ||