diff options
| author | Mark Hung <marklh9@gmail.com> | 2018-10-06 15:23:18 +0800 |
|---|---|---|
| committer | Mark Hung <marklh9@gmail.com> | 2018-10-18 14:45:36 +0200 |
| commit | c2545303f7c0c18c4b65e50006bcedb5fe31aa4c (patch) | |
| tree | 98d57b8cf1bf55ec9a9aa517bb1f2b76d5ac59a7 /offapi | |
| parent | 4c68cf2636573c97e69ae73cb9a0b65019efd26a (diff) | |
offapi: document queryLogicalAdvancements() for XTextLayout.
Based on implementation, explain the definition of logical
advancements for RTL and LTR case and remove incorrect part.
Logical advancements are distances to the edge instead of
widths of characters, so summing all do not yield the
total.
Change-Id: I437f490e5025c2124238e8cad506a966d7bc792c
Reviewed-on: https://gerrit.libreoffice.org/61461
Tested-by: Jenkins
Reviewed-by: Mark Hung <marklh9@gmail.com>
Diffstat (limited to 'offapi')
| -rw-r--r-- | offapi/com/sun/star/rendering/XTextLayout.idl | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index c19fbaba26ad..dc71f857e2cf 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -113,10 +113,14 @@ interface XTextLayout : ::com::sun::star::uno::XInterface This method returns a sequence of advancements, one for each character in the input string (<em>not</em> for every glyph. There might be multiple glyphs per input character, or - multiple input characters per glyph). Adding up all - advancements yields the total advancement of this layout. To - manipulate the layout of a string on the level of characters, - this method can be used to query for the layout's default + multiple input characters per glyph). + + An advancement value is the distance of the glyph to the beginning + edge, which is left for LTR text and is right for RTL text. The + maximum of the advancements can be deemed as the width of the whole + text layout. + + This method can be used to query for the layout's default advancements, which can subsequently be changed and applied to the layout via XTextLayout::applyLogicalAdvancements().<p> |