diff options
| author | Chong Yidong | 2013-12-20 15:12:04 +0800 |
|---|---|---|
| committer | Chong Yidong | 2013-12-20 15:12:04 +0800 |
| commit | f5df4cebdb5e2edfddd8b8e16b1c237e2dd45855 (patch) | |
| tree | 1adb7cc9be1a1ba3ba7d0e90f5c3b59a2a414b1f /src/textprop.c | |
| parent | ca65efcc2ea7f6876fee2f7d2d929dffa4093f96 (diff) | |
| download | emacs-f5df4cebdb5e2edfddd8b8e16b1c237e2dd45855.tar.gz emacs-f5df4cebdb5e2edfddd8b8e16b1c237e2dd45855.zip | |
Add/fix docs for add-face-text-property
* doc/lispref/text.texi (Changing Properties): Improve documentation for
add-face-text-property.
(Special Properties): Mention add-face-text-property.
* src/textprop.c (Fadd_face_text_property): Doc fix. Rename `appendp'
argument to `append'.
Diffstat (limited to 'src/textprop.c')
| -rw-r--r-- | src/textprop.c | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/src/textprop.c b/src/textprop.c index 5597a781a61..d5f86922ade 100644 --- a/src/textprop.c +++ b/src/textprop.c | |||
| @@ -1338,20 +1338,27 @@ the designated part of OBJECT. */) | |||
| 1338 | DEFUN ("add-face-text-property", Fadd_face_text_property, | 1338 | DEFUN ("add-face-text-property", Fadd_face_text_property, |
| 1339 | Sadd_face_text_property, 3, 5, 0, | 1339 | Sadd_face_text_property, 3, 5, 0, |
| 1340 | doc: /* Add the face property to the text from START to END. | 1340 | doc: /* Add the face property to the text from START to END. |
| 1341 | The third argument FACE specifies the face to add. | 1341 | FACE specifies the face to add. It should be a valid value of the |
| 1342 | If any text in the region already has any face properties, this new | 1342 | `face' property (typically a face name or a plist of face attributes |
| 1343 | face property will be added to the front of the face property list. | 1343 | and values). |
| 1344 | If the optional fourth argument APPENDP is non-nil, append to the end | 1344 | |
| 1345 | of the face property list instead. | 1345 | If any text in the region already has a non-nil `face' property, those |
| 1346 | If the optional fifth argument OBJECT is a buffer (or nil, which means | 1346 | face(s) are retained. This is done by setting the `face' property to |
| 1347 | the current buffer), START and END are buffer positions (integers or | 1347 | a list of faces, with FACE as the first element (by default) and the |
| 1348 | pre-existing faces as the remaining elements. | ||
| 1349 | |||
| 1350 | If optional fourth argument APPEND is non-nil, append FACE to the end | ||
| 1351 | of the face list instead. | ||
| 1352 | |||
| 1353 | If optional fifth argument OBJECT is a buffer (or nil, which means the | ||
| 1354 | current buffer), START and END are buffer positions (integers or | ||
| 1348 | markers). If OBJECT is a string, START and END are 0-based indices | 1355 | markers). If OBJECT is a string, START and END are 0-based indices |
| 1349 | into it. */) | 1356 | into it. */) |
| 1350 | (Lisp_Object start, Lisp_Object end, Lisp_Object face, | 1357 | (Lisp_Object start, Lisp_Object end, Lisp_Object face, |
| 1351 | Lisp_Object appendp, Lisp_Object object) | 1358 | Lisp_Object append, Lisp_Object object) |
| 1352 | { | 1359 | { |
| 1353 | add_text_properties_1 (start, end, list2 (Qface, face), object, | 1360 | add_text_properties_1 (start, end, list2 (Qface, face), object, |
| 1354 | (NILP (appendp) | 1361 | (NILP (append) |
| 1355 | ? TEXT_PROPERTY_PREPEND | 1362 | ? TEXT_PROPERTY_PREPEND |
| 1356 | : TEXT_PROPERTY_APPEND)); | 1363 | : TEXT_PROPERTY_APPEND)); |
| 1357 | return Qnil; | 1364 | return Qnil; |