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

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