Mercurial > emacs
changeset 59516:f50d20947c20
(Emulating Mode Line): Update format-mode-line entry.
| author | Kim F. Storm <storm@cua.dk> |
|---|---|
| date | Thu, 13 Jan 2005 09:39:32 +0000 |
| parents | 77893ec9b41e |
| children | 6f663dc1995f |
| files | lispref/modes.texi |
| diffstat | 1 files changed, 3 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/modes.texi Thu Jan 13 09:39:09 2005 +0000 +++ b/lispref/modes.texi Thu Jan 13 09:39:32 2005 +0000 @@ -1736,7 +1736,7 @@ the text that would appear in a mode line or header line based on certain mode-line specification. -@defun format-mode-line format &optional window no-props buffer face +@defun format-mode-line format &optional face window 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,13 +1752,12 @@ that stands for either @code{mode-line} if @var{window} is selected, otherwise @code{mode-line-inactive}.) -However, if @var{no-props} is non-@code{nil}, the value has no text -properties. +However, if @var{face} is an integer, the value has no text properties. For example, @code{(format-mode-line header-line-format)} returns the text that would appear in the selected window's header line (@code{""} if it has no header line). @code{(format-mode-line header-line-format -nil nil nil 'header-line)} returns the same text, with each character +'header-line)} returns the same text, with each character carrying the face that it will have in the header line itself. @end defun