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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_Caret_idl__
  20 #define __com_sun_star_rendering_Caret_idl__
  21
  22 module com { module sun { module star { module rendering {
  23
  24 /** This structure contains the caret information.<p>
  25
  26     This structure is used from the XTextLayout interface
  27     to transport information regarding a text caret.<p>
  28
  29     @since OOo 2.0
  30  */
  31 struct Caret
  32 {
  33     /** This contains the main caret index.<p>
  34
  35         The main caret index corresponds to the insert position when
  36         inserting text in the layout's main text direction.
  37      */
  38     long        MainCaretIndex;
  39
  40     /** This contains the secondary caret index.<p>
  41
  42         The secondary caret index, when different from the main caret
  43         index, corresponds to the insert position when inserting text
  44         at a direction change opposite to the layout's main text
  45         direction.
  46      */
  47     long        SecondaryCaretIndex;
  48
  49     /** The angle of the caret.<p>
  50
  51         This member contains the rotation angle of the caret in
  52         degrees, with 0 denoting an unrotated caret (the unrotated
  53         caret orientation depends on the writing mode, horizontally or
  54         vertically). The rotation angle is positive for
  55         counter-clockwise rotations.<p>
  56      */
  57     double      CaretAngle;
  58 };
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */