Mercurial > emacs
comparison lisp/composite.el @ 103436:850fd8c37942
(compose-region): Improve the docstring.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Tue, 16 Jun 2009 00:33:18 +0000 |
parents | 8fb6a5d3b48d |
children | f0794252d960 |
comparison
equal
deleted
inserted
replaced
103435:45564d023acc | 103436:850fd8c37942 |
---|---|
183 components) | 183 components) |
184 | 184 |
185 (defun compose-region (start end &optional components modification-func) | 185 (defun compose-region (start end &optional components modification-func) |
186 "Compose characters in the current region. | 186 "Compose characters in the current region. |
187 | 187 |
188 Characters are composed relatively, i.e. composed by overstricking or | 188 Characters are composed relatively, i.e. composed by overstriking |
189 stacking depending on ascent, descent and other properties. | 189 or stacking depending on ascent, descent and other metrics of |
190 glyphs. | |
191 | |
192 For instance, if the region has three characters \"XYZ\", X is | |
193 regarded as BASE glyph, and Y is displayed: | |
194 (1) above BASE if Y's descent value is not positive | |
195 (2) below BASE if Y's ascent value is not positive | |
196 (3) on BASE (i.e. at the BASE position) otherwise | |
197 and Z is displayed with the same rule while regarding the whole | |
198 XY glyphs as BASE. | |
190 | 199 |
191 When called from a program, expects these four arguments. | 200 When called from a program, expects these four arguments. |
192 | 201 |
193 First two arguments START and END are positions (integers or markers) | 202 First two arguments START and END are positions (integers or markers) |
194 specifying the region. | 203 specifying the region. |