offapi/com/sun/star/rendering/Caret.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_rendering_Caret_idl__
  28 #define __com_sun_star_rendering_Caret_idl__
  29
  30 module com { module sun { module star { module rendering {
  31
  32 /** This structure contains the caret information.<p>
  33
  34     This structure is used from the <type>XTextLayout</type> interface
  35     to transport information regarding a text caret.<p>
  36
  37     @since OOo 2.0.0
  38  */
  39 struct Caret
  40 {
  41     /** This contains the main caret index.<p>
  42
  43         The main caret index corresponds to the insert position when
  44         inserting text in the layout's main text direction.
  45      */
  46     long        MainCaretIndex;
  47
  48     /** This contains the secondary caret index.<p>
  49
  50         The secondary caret index, when different from the main caret
  51         index, corresponds to the insert position when inserting text
  52         at a direction change opposite to the layout's main text
  53         direction.
  54      */
  55     long        SecondaryCaretIndex;
  56
  57     /** The angle of the caret.<p>
  58
  59         This member contains the rotation angle of the caret in
  60         degrees, with 0 denoting an unrotated caret (the unrotated
  61         caret orientation depends on the writing mode, horizontally or
  62         vertically). The rotation angle is positive for
  63         counter-clockwise rotations.<p>
  64      */
  65     double      CaretAngle;
  66 };
  67
  68 }; }; }; };
  69
  70 #endif