Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

:: com :: sun :: star :: rendering ::

unpublished struct Caret
Description
This structure contains the caret information.

This structure is used from the XTextLayout interface to transport information regarding a text caret.

Since
OOo 2.0.0

Elements' Summary
MainCaretIndex This contains the main caret index.  
SecondaryCaretIndex This contains the secondary caret index.  
CaretAngle The angle of the caret.  
Elements' Details
MainCaretIndex
long MainCaretIndex;
Description
This contains the main caret index.

The main caret index corresponds to the insert position when inserting text in the layout's main text direction.

SecondaryCaretIndex
long SecondaryCaretIndex;
Description
This contains the secondary caret index.

The secondary caret index, when different from the main caret index, corresponds to the insert position when inserting text at a direction change opposite to the layout's main text direction.

CaretAngle
double CaretAngle;
Description
The angle of the caret.

This member contains the rotation angle of the caret in degrees, with 0 denoting an unrotated caret (the unrotated caret orientation depends on the writing mode, horizontally or vertically). The rotation angle is positive for counter-clockwise rotations.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.