1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_rendering_Caret_idl__ 24#define __com_sun_star_rendering_Caret_idl__ 25 26module com { module sun { module star { module rendering { 27 28/** This structure contains the caret information.<p> 29 30 This structure is used from the <type>XTextLayout</type> interface 31 to transport information regarding a text caret.<p> 32 33 @since OpenOffice 2.0 34 */ 35published struct Caret 36{ 37 /** This contains the main caret index.<p> 38 39 The main caret index corresponds to the insert position when 40 inserting text in the layout's main text direction. 41 */ 42 long MainCaretIndex; 43 44 /** This contains the secondary caret index.<p> 45 46 The secondary caret index, when different from the main caret 47 index, corresponds to the insert position when inserting text 48 at a direction change opposite to the layout's main text 49 direction. 50 */ 51 long SecondaryCaretIndex; 52 53 /** The angle of the caret.<p> 54 55 This member contains the rotation angle of the caret in 56 degrees, with 0 denoting an unrotated caret (the unrotated 57 caret orientation depends on the writing mode, horizontally or 58 vertically). The rotation angle is positive for 59 counter-clockwise rotations.<p> 60 */ 61 double CaretAngle; 62}; 63 64}; }; }; }; 65 66#endif 67