office-gobmx/offapi/com/sun/star/rendering/Caret.idl

70 lines
2.4 KiB
Text

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_rendering_Caret_idl__
#define __com_sun_star_rendering_Caret_idl__
module com { module sun { module star { module rendering {
/** This structure contains the caret information.<p>
This structure is used from the <type>XTextLayout</type> interface
to transport information regarding a text caret.<p>
@since OOo 2.0.0
*/
struct Caret
{
/** This contains the main caret index.<p>
The main caret index corresponds to the insert position when
inserting text in the layout's main text direction.
*/
long MainCaretIndex;
/** This contains the secondary caret index.<p>
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.
*/
long SecondaryCaretIndex;
/** The angle of the caret.<p>
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.<p>
*/
double CaretAngle;
};
}; }; }; };
#endif