]> git.eshelyaron.com Git - emacs.git/commitdiff
(Emulating Mode Line): Update format-mode-line entry.
authorKim F. Storm <storm@cua.dk>
Thu, 13 Jan 2005 09:39:32 +0000 (09:39 +0000)
committerKim F. Storm <storm@cua.dk>
Thu, 13 Jan 2005 09:39:32 +0000 (09:39 +0000)
lispref/modes.texi

index ebedbc520b85a15329d1649e08f2bff51886869b..24cf95d6985286eb83498a8d9b88e1029da8ebba 100644 (file)
@@ -1736,7 +1736,7 @@ It is normally @code{nil}, so that ordinary buffers have no header line.
 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 @@ value which is usually @var{face}.  (If @var{face} is @code{t},
 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