1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
19 #ifndef __com_sun_star_drawing_TextProperties_idl__
20 #define __com_sun_star_drawing_TextProperties_idl__
22 #include
<com
/sun
/star
/container
/XIndexReplace.idl
>
24 #include
<com
/sun
/star
/style
/CharacterProperties.idl
>
25 #include
<com
/sun
/star
/style
/CharacterPropertiesAsian.idl
>
26 #include
<com
/sun
/star
/style
/CharacterPropertiesComplex.idl
>
28 #include
<com
/sun
/star
/style
/ParagraphProperties.idl
>
29 #include
<com
/sun
/star
/style
/ParagraphPropertiesAsian.idl
>
30 #include
<com
/sun
/star
/style
/ParagraphPropertiesComplex.idl
>
32 #include
<com
/sun
/star
/drawing
/TextFitToSizeType.idl
>
34 #include
<com
/sun
/star
/drawing
/TextAdjust.idl
>
36 #include
<com
/sun
/star
/drawing
/TextAnimationDirection.idl
>
38 #include
<com
/sun
/star
/drawing
/TextAnimationKind.idl
>
40 #include
<com
/sun
/star
/drawing
/TextVerticalAdjust.idl
>
41 #include
<com
/sun
/star
/drawing
/TextHorizontalAdjust.idl
>
42 #include
<com
/sun
/star
/text
/WritingMode.idl
>
45 module com
{ module sun
{ module star
{ module drawing
{
49 /** This is a set of properties to describe the style for rendering the
50 text area inside a shape.
52 published service TextProperties
54 /** The properties in this service set default formats for text
57 service com
::sun
::star
::style
::CharacterProperties
;
60 /** The properties in this service set default formats for Asian text
63 [optional] service com
::sun
::star
::style
::CharacterPropertiesAsian
;
66 /** The properties in this service set default formats for complex text
69 [optional] service com
::sun
::star
::style
::CharacterPropertiesComplex
;
72 /** The properties in this service set default formats for text
75 service com
::sun
::star
::style
::ParagraphProperties
;
78 /** The properties in this service set default formats for Asian text
81 [optional] service com
::sun
::star
::style
::ParagraphPropertiesAsian
;
84 /** The properties in this service set default formats for complex text
87 [optional] service com
::sun
::star
::style
::ParagraphPropertiesComplex
;
89 /** If this is `TRUE`, numbering is ON for the text of
92 [optional, property
] boolean IsNumbering
;
95 /** describes the numbering levels.
96 <p>The different rules accessible with this
97 com::sun::star::container::XIndexReplace interface
98 are sequences of property values as described in the service
99 com::sun::star::style::NumberingRule.</p>
101 [optional, property
] com
::sun
::star
::container
::XIndexReplace NumberingRules
;
104 /** If this value is `TRUE`, the height of the Shape is
105 automatically expanded/shrunk when text is added to or removed from
108 [property
] boolean TextAutoGrowHeight
;
111 /** If this value is `TRUE`, the width of the Shape is
112 automatically expanded/shrunk when text is added to or removed from
115 [property
] boolean TextAutoGrowWidth
;
117 /** If this value is `TRUE`, the left edge of every line of text is
118 aligned with the left edge of this Shape.
120 [property
] boolean TextContourFrame
;
123 /** With this set to `TRUE`, the text inside of the Shape
124 is stretched to fit into the Shape.
126 [property
] com
::sun
::star
::drawing
::TextFitToSizeType TextFitToSize
;
129 /** adjusts the horizontal position of the text inside of
132 [property
] com
::sun
::star
::drawing
::TextHorizontalAdjust TextHorizontalAdjust
;
135 /** adjusts the vertical position of the text inside of
138 [property
] com
::sun
::star
::drawing
::TextVerticalAdjust TextVerticalAdjust
;
141 /** This is the distance from the left edge of the Shape
142 to the left edge of the text.
143 <p>This is only useful if Text::TextHorizontalAdjust is
144 BLOCK or STRETCH or if
145 Text::TextFitSize is `TRUE`.</p>
147 [property
] long TextLeftDistance
;
150 /** This is the distance from the right edge of the Shape
151 to the right edge of the text.
153 <p>This is only useful if Text::TextHorizontalAdjust is
155 or if Text::TextFitSize is `TRUE`.</p>
157 [property
] long TextRightDistance
;
160 /** This is the distance from the upper edge of the Shape to
161 the upper edge of the text.
163 <p>This is only useful if Text::TextVerticalAdjust is
164 BLOCK or if Text::TextFitSize is
167 [property
] long TextUpperDistance
;
170 /** This is the distance from the lower edge of the Shape to the
171 lower edge of the text.
175 <p>This is only useful if Text::TextVerticalAdjust is
176 BLOCK or if Text::TextFitSize is
179 [property
] long TextLowerDistance
;
182 /** with this property you can set the maximum height for a shape with text.
183 On edit, the auto grow feature will not grow the object higher than
184 the value of this property.
186 [property
] long TextMaximumFrameHeight
;
189 /** with this property you can set the maximum width for a shape with text.
190 On edit, the auto grow feature will not grow the objects wider than
191 the value of this property.
193 [property
] long TextMaximumFrameWidth
;
196 /** with this property you can set the minimum height for a shape with text.
197 On edit, the auto grow feature will not shrink the objects height smaller
198 than the value of this property.
200 [property
] long TextMinimumFrameHeight
;
203 /** with this property you can set the minimum width for a shape with text.
204 On edit, the auto grow feature will not shrink the object width smaller
205 than the value of this property.
207 [property
] long TextMinimumFrameWidth
;
210 /** This is the number of pixels the text is moved in each animation step.
212 [property
] short TextAnimationAmount
;
215 /** This number defines how many times the text animation is repeated.
216 <p>If this is set to zero, the repeat is endless.</p>
218 [property
] short TextAnimationCount
;
221 /** This is the delay in thousandths of a second between each
222 of the animation steps.
224 [property
] short TextAnimationDelay
;
227 /** This enumeration defines the direction in which the text moves.
229 [property
] com
::sun
::star
::drawing
::TextAnimationDirection TextAnimationDirection
;
232 /** This value defines the type of animation.
234 [property
] com
::sun
::star
::drawing
::TextAnimationKind TextAnimationKind
;
237 /** If this value is `TRUE`, the text is visible at the start of the
240 [property
] boolean TextAnimationStartInside
;
243 /** If this value is `TRUE`, the text is visible at the end of the
246 [property
] boolean TextAnimationStopInside
;
249 /** This value selects the writing mode for the text.
251 [property
] ::com
::sun
::star
::text
::WritingMode TextWritingMode
;
259 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */