/[emacs]/emacs/lispref/modes.texi
ViewVC logotype

Diff of /emacs/lispref/modes.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.82 by rms, Mon Dec 27 16:58:07 2004 UTC revision 1.83 by rms, Thu Jan 6 17:42:58 2005 UTC
# Line 1736  It is normally @code{nil}, so that ordin Line 1736  It is normally @code{nil}, so that ordin
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

Legend:
Removed from v.1.82  
changed lines
  Added in v.1.83

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26