Mercurial > emacs
changeset 98729:a0397c75f952
(Major Mode Conventions, Mode Line Variables): `mode-name' need not be a
string. xref to "Mode Line Data" for details, and to "Emulating Mode Line"
for computing a string value.
| author | Eli Zaretskii <eliz@gnu.org> |
|---|---|
| date | Wed, 15 Oct 2008 11:25:22 +0000 |
| parents | a962df9a86fb |
| children | 7ff14b28125a |
| files | doc/lispref/modes.texi |
| diffstat | 1 files changed, 9 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lispref/modes.texi Tue Oct 14 19:01:50 2008 +0000 +++ b/doc/lispref/modes.texi Wed Oct 15 11:25:22 2008 +0000 @@ -317,8 +317,9 @@ @item The major mode command should set the variable @code{mode-name} to the -``pretty'' name of the mode, as a string. This string appears in the -mode line. +``pretty'' name of the mode, usually a string (but see @ref{Mode Line +Data}, for other possible forms). The name of the mode appears +in the mode line. @item @cindex functions in modes @@ -1865,8 +1866,12 @@ @defvar mode-name This buffer-local variable holds the ``pretty'' name of the current -buffer's major mode. Each major mode should set this variable so that the -mode name will appear in the mode line. +buffer's major mode. Each major mode should set this variable so that +the mode name will appear in the mode line. The value does not have +to be a string, but can use any of the data types valid in a mode-line +construct (@pxref{Mode Line Data}). To compute the string that will +identify the mode name in the mode line, use @code{format-mode-line} +(@pxref{Emulating Mode Line}). @end defvar @defvar mode-line-process