Mercurial > emacs
comparison src/buffer.c @ 48305:55b6e3969474
(syms_of_buffer) <mode-line-format>: Document symbol
dependency on `risky-local-variable' and the :propertize form.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Thu, 14 Nov 2002 11:44:16 +0000 |
parents | efcead0d345a |
children | 77552fd065a0 |
comparison
equal
deleted
inserted
replaced
48304:bf28f5db93ce | 48305:55b6e3969474 |
---|---|
5257 Value may be nil, a string, a symbol or a list or cons cell. | 5257 Value may be nil, a string, a symbol or a list or cons cell. |
5258 A value of nil means don't display a mode line. | 5258 A value of nil means don't display a mode line. |
5259 For a symbol, its value is used (but it is ignored if t or nil). | 5259 For a symbol, its value is used (but it is ignored if t or nil). |
5260 A string appearing directly as the value of a symbol is processed verbatim | 5260 A string appearing directly as the value of a symbol is processed verbatim |
5261 in that the %-constructs below are not recognized. | 5261 in that the %-constructs below are not recognized. |
5262 Note that unless the symbol is marked as a `risky-local-variable', all | |
5263 properties in any strings, as well as all :eval and :propertize forms | |
5264 in the value of that symbol will be ignored. | |
5262 For a list of the form `(:eval FORM)', FORM is evaluated and the result | 5265 For a list of the form `(:eval FORM)', FORM is evaluated and the result |
5263 is used as a mode line element. | 5266 is used as a mode line element. |
5267 For a list of the form `(:propertize ELT PROPS...)', ELT is displayed | |
5268 with the specified properties PROPS applied. | |
5264 For a list whose car is a symbol, the symbol's value is taken, | 5269 For a list whose car is a symbol, the symbol's value is taken, |
5265 and if that is non-nil, the cadr of the list is processed recursively. | 5270 and if that is non-nil, the cadr of the list is processed recursively. |
5266 Otherwise, the caddr of the list (if there is one) is processed. | 5271 Otherwise, the caddr of the list (if there is one) is processed. |
5267 For a list whose car is a string or list, each element is processed | 5272 For a list whose car is a string or list, each element is processed |
5268 recursively and the results are effectively concatenated. | 5273 recursively and the results are effectively concatenated. |