summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/rendering/Caret.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/rendering/Caret.idl')
-rw-r--r--offapi/com/sun/star/rendering/Caret.idl64
1 files changed, 64 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/Caret.idl b/offapi/com/sun/star/rendering/Caret.idl
new file mode 100644
index 000000000..5677e798e
--- /dev/null
+++ b/offapi/com/sun/star/rendering/Caret.idl
@@ -0,0 +1,64 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#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 XTextLayout interface
+ to transport information regarding a text caret.<p>
+
+ @since OOo 2.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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */