1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextProperties_idl__
24cdf0e10cSrcweir#define __com_sun_star_drawing_TextProperties_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexReplace_idl__
27cdf0e10cSrcweir#include <com/sun/star/container/XIndexReplace.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_style_CharacterProperties_idl__
31cdf0e10cSrcweir#include <com/sun/star/style/CharacterProperties.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
35cdf0e10cSrcweir#include <com/sun/star/style/CharacterPropertiesAsian.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
39cdf0e10cSrcweir#include <com/sun/star/style/CharacterPropertiesComplex.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_style_ParagraphProperties_idl__
43cdf0e10cSrcweir#include <com/sun/star/style/ParagraphProperties.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir#ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
47cdf0e10cSrcweir#include <com/sun/star/style/ParagraphPropertiesAsian.idl>
48cdf0e10cSrcweir#endif
49cdf0e10cSrcweir
50cdf0e10cSrcweir#ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
51cdf0e10cSrcweir#include <com/sun/star/style/ParagraphPropertiesComplex.idl>
52cdf0e10cSrcweir#endif
53cdf0e10cSrcweir
54cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextFitToSizeType_idl__
55cdf0e10cSrcweir#include <com/sun/star/drawing/TextFitToSizeType.idl>
56cdf0e10cSrcweir#endif
57cdf0e10cSrcweir
58cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextAdjust_idl__
59cdf0e10cSrcweir#include <com/sun/star/drawing/TextAdjust.idl>
60cdf0e10cSrcweir#endif
61cdf0e10cSrcweir
62cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextAnimationDirection_idl__
63cdf0e10cSrcweir#include <com/sun/star/drawing/TextAnimationDirection.idl>
64cdf0e10cSrcweir#endif
65cdf0e10cSrcweir
66cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextAnimationKind_idl__
67cdf0e10cSrcweir#include <com/sun/star/drawing/TextAnimationKind.idl>
68cdf0e10cSrcweir#endif
69cdf0e10cSrcweir
70cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextVerticalAdjust_idl__
71cdf0e10cSrcweir#include <com/sun/star/drawing/TextVerticalAdjust.idl>
72cdf0e10cSrcweir#endif
73cdf0e10cSrcweir
74cdf0e10cSrcweir#ifndef __com_sun_star_drawing_TextHorizontalAdjust_idl__
75cdf0e10cSrcweir#include <com/sun/star/drawing/TextHorizontalAdjust.idl>
76cdf0e10cSrcweir#endif
77cdf0e10cSrcweir
78cdf0e10cSrcweir#ifndef __com_sun_star_text_WritingMode_idl__
79cdf0e10cSrcweir#include <com/sun/star/text/WritingMode.idl>
80cdf0e10cSrcweir#endif
81cdf0e10cSrcweir
82cdf0e10cSrcweir//=============================================================================
83cdf0e10cSrcweir
84cdf0e10cSrcweir module com {  module sun {  module star {  module drawing {
85cdf0e10cSrcweir
86cdf0e10cSrcweir//=============================================================================
87cdf0e10cSrcweir
88cdf0e10cSrcweir
89cdf0e10cSrcweir/** This is a set of properties to describe the style for rendering the
90cdf0e10cSrcweir	text area inside a shape.
91cdf0e10cSrcweir */
92cdf0e10cSrcweirpublished service TextProperties
93cdf0e10cSrcweir{
94cdf0e10cSrcweir	/** The properties in this service set default formats for text
95cdf0e10cSrcweir		inside the <type>Shape</type>.
96cdf0e10cSrcweir	 */
97cdf0e10cSrcweir	service com::sun::star::style::CharacterProperties;
98cdf0e10cSrcweir
99cdf0e10cSrcweir	//-------------------------------------------------------------------------
100cdf0e10cSrcweir
101cdf0e10cSrcweir	/** The properties in this service set default formats for asian text
102cdf0e10cSrcweir		inside the <type>Shape</type>.
103cdf0e10cSrcweir	 */
104cdf0e10cSrcweir	[optional] service com::sun::star::style::CharacterPropertiesAsian;
105cdf0e10cSrcweir
106cdf0e10cSrcweir	//-------------------------------------------------------------------------
107cdf0e10cSrcweir
108cdf0e10cSrcweir	/** The properties in this service set default formats for complex text
109cdf0e10cSrcweir		inside the <type>Shape</type>.
110cdf0e10cSrcweir	 */
111cdf0e10cSrcweir	[optional] service com::sun::star::style::CharacterPropertiesComplex;
112cdf0e10cSrcweir
113cdf0e10cSrcweir	//-------------------------------------------------------------------------
114cdf0e10cSrcweir
115cdf0e10cSrcweir	/** The properties in this service set default formats for text
116cdf0e10cSrcweir		inside the <type>Shape</type>.
117cdf0e10cSrcweir	 */
118cdf0e10cSrcweir	service com::sun::star::style::ParagraphProperties;
119cdf0e10cSrcweir
120cdf0e10cSrcweir	//-------------------------------------------------------------------------
121cdf0e10cSrcweir
122cdf0e10cSrcweir	/** The properties in this service set default formats for asian text
123cdf0e10cSrcweir		inside the <type>Shape</type>.
124cdf0e10cSrcweir	 */
125cdf0e10cSrcweir	[optional] service com::sun::star::style::ParagraphPropertiesAsian;
126cdf0e10cSrcweir
127cdf0e10cSrcweir	//-------------------------------------------------------------------------
128cdf0e10cSrcweir
129cdf0e10cSrcweir	/** The properties in this service set default formats for complex text
130cdf0e10cSrcweir		inside the <type>Shape</type>.
131cdf0e10cSrcweir	 */
132cdf0e10cSrcweir	[optional] service com::sun::star::style::ParagraphPropertiesComplex;
133cdf0e10cSrcweir	//-------------------------------------------------------------------------
134cdf0e10cSrcweir
135cdf0e10cSrcweir	/** If this is <TRUE/>, numbering is ON for the text of
136cdf0e10cSrcweir		this <type>Shape</type>.
137cdf0e10cSrcweir	 */
138cdf0e10cSrcweir	[optional, property] boolean IsNumbering;
139cdf0e10cSrcweir
140cdf0e10cSrcweir	//-------------------------------------------------------------------------
141cdf0e10cSrcweir
142cdf0e10cSrcweir	/** describes the numbering levels.
143cdf0e10cSrcweir		<p>The different rules accessible with this
144cdf0e10cSrcweir		<type scope="com::sun::star::container">XIndexReplace</type> interface
145cdf0e10cSrcweir		are sequences of property values as described in the service
146cdf0e10cSrcweir		<type scope="com::sun::star::style">NumberingRule</type>.</p>
147cdf0e10cSrcweir	 */
148cdf0e10cSrcweir	[optional, property] com::sun::star::container::XIndexReplace NumberingRules;
149cdf0e10cSrcweir
150cdf0e10cSrcweir	//-------------------------------------------------------------------------
151cdf0e10cSrcweir
152cdf0e10cSrcweir	/** If this value is <TRUE/>, the height of the <type>Shape</type> is
153cdf0e10cSrcweir		automatically expanded/shrunk when text is added to or removed from
154cdf0e10cSrcweir		the <type>Shape</type>.
155cdf0e10cSrcweir	 */
156cdf0e10cSrcweir	[property] boolean TextAutoGrowHeight;
157cdf0e10cSrcweir
158cdf0e10cSrcweir	//-------------------------------------------------------------------------
159cdf0e10cSrcweir
160cdf0e10cSrcweir	/** If this value is <TRUE/>, the width of the <type>Shape</type> is
161cdf0e10cSrcweir		automatically expanded/shrunk when text is added to or removed from
162cdf0e10cSrcweir		the <type>Shape</type>.
163cdf0e10cSrcweir	 */
164cdf0e10cSrcweir	[property] boolean TextAutoGrowWidth;
165cdf0e10cSrcweir
166cdf0e10cSrcweir	//-------------------------------------------------------------------------
167cdf0e10cSrcweir
168cdf0e10cSrcweir	// DocMerge from xml: property com::sun::star::drawing::Text::TextContourFrame
169cdf0e10cSrcweir	/** If this value is <TRUE/>, the left edge of every line of text is
170cdf0e10cSrcweir		aligned with the left edge of this <type>Shape</type>.
171cdf0e10cSrcweir	 */
172cdf0e10cSrcweir	[property] boolean TextContourFrame;
173cdf0e10cSrcweir
174cdf0e10cSrcweir	//-------------------------------------------------------------------------
175cdf0e10cSrcweir
176cdf0e10cSrcweir	/** With this set to <TRUE/>, the text inside of the <type>Shape</type>
177cdf0e10cSrcweir		is stretched to fit into the <type>Shape</type>.
178cdf0e10cSrcweir	 */
179cdf0e10cSrcweir	[property] com::sun::star::drawing::TextFitToSizeType TextFitToSize;
180cdf0e10cSrcweir
181cdf0e10cSrcweir	//-------------------------------------------------------------------------
182cdf0e10cSrcweir
183cdf0e10cSrcweir	/** adjusts the horizontal position of the text inside of
184cdf0e10cSrcweir		the <type>Shape</type>.
185cdf0e10cSrcweir	 */
186cdf0e10cSrcweir	[property] com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust;
187cdf0e10cSrcweir
188cdf0e10cSrcweir	//-------------------------------------------------------------------------
189cdf0e10cSrcweir
190cdf0e10cSrcweir	/** adjusts the vertical position of the text inside of
191cdf0e10cSrcweir		the <type>Shape</type>.
192cdf0e10cSrcweir	 */
193cdf0e10cSrcweir	[property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust;
194cdf0e10cSrcweir
195cdf0e10cSrcweir	//-------------------------------------------------------------------------
196cdf0e10cSrcweir
197cdf0e10cSrcweir	/** This is the distance from the left edge of the <type>Shape</type>
198cdf0e10cSrcweir		to the left edge of the text.
199cdf0e10cSrcweir		<p>This is only useful if <member>Text::TextHorizontalAdjust</member> is
200cdf0e10cSrcweir		<const>BLOCK</const> or <const>STRETCH</const> or if
201cdf0e10cSrcweir		<member>Text::TextFitSize</member> is <TRUE/>.</p>
202cdf0e10cSrcweir	 */
203cdf0e10cSrcweir	[property] long TextLeftDistance;
204cdf0e10cSrcweir
205cdf0e10cSrcweir	//-------------------------------------------------------------------------
206cdf0e10cSrcweir
207cdf0e10cSrcweir	/** This is the distance from the right edge of the <type>Shape</type>
208cdf0e10cSrcweir		to the right edge of the text.
209cdf0e10cSrcweir
210cdf0e10cSrcweir		<p>This is only useful if <member>Text::TextHorizontalAdjust</member> is
211cdf0e10cSrcweir		<const>BLOCK</const> or <const>STRETCH</const>
212cdf0e10cSrcweir		or if <member>Text::TextFitSize</member> is <TRUE/>.</p>
213cdf0e10cSrcweir	 */
214cdf0e10cSrcweir	[property] long TextRightDistance;
215cdf0e10cSrcweir
216cdf0e10cSrcweir	//-------------------------------------------------------------------------
217cdf0e10cSrcweir
218cdf0e10cSrcweir	/** This is the distance from the upper edge of the <type>Shape</type> to
219cdf0e10cSrcweir		the upper edge of the text.
220cdf0e10cSrcweir
221cdf0e10cSrcweir		<p>This is only useful if <member>Text::TextVerticalAdjust</member> is
222cdf0e10cSrcweir		<const>BLOCK</const> or if <member>Text::TextFitSize</member> is
223cdf0e10cSrcweir		<TRUE/>.</p>
224cdf0e10cSrcweir	 */
225cdf0e10cSrcweir	[property] long TextUpperDistance;
226cdf0e10cSrcweir
227cdf0e10cSrcweir	//-------------------------------------------------------------------------
228cdf0e10cSrcweir
229cdf0e10cSrcweir	/** This is the distance from the lower edge of the <type>Shape</type> to the
230cdf0e10cSrcweir		lower edge of the text.
231cdf0e10cSrcweir
232cdf0e10cSrcweir
233cdf0e10cSrcweir
234cdf0e10cSrcweir		<p>This is only useful if <member>Text::TextVerticalAdjust</member> is
235cdf0e10cSrcweir		<const>BLOCK</const> or if <member>Text::TextFitSize</member> is
236cdf0e10cSrcweir		<TRUE/>.</p>
237cdf0e10cSrcweir	 */
238cdf0e10cSrcweir	[property] long TextLowerDistance;
239cdf0e10cSrcweir
240cdf0e10cSrcweir	//-------------------------------------------------------------------------
241cdf0e10cSrcweir
242cdf0e10cSrcweir	/** with this property you can set the maximum height for a shape with text.
243cdf0e10cSrcweir		On edit, the auto grow feature will not grow the object heigher than
244cdf0e10cSrcweir		the value of this property.
245cdf0e10cSrcweir	*/
246cdf0e10cSrcweir	[property] long TextMaximumFrameHeight;
247cdf0e10cSrcweir
248cdf0e10cSrcweir	//-------------------------------------------------------------------------
249cdf0e10cSrcweir
250cdf0e10cSrcweir	/** with this property you can set the maximum width for a shape with text.
251cdf0e10cSrcweir		On edit, the auto grow feature will not grow the objects wider than
252cdf0e10cSrcweir		the value of this property.
253cdf0e10cSrcweir	*/
254cdf0e10cSrcweir	[property] long TextMaximumFrameWidth;
255cdf0e10cSrcweir
256cdf0e10cSrcweir	//-------------------------------------------------------------------------
257cdf0e10cSrcweir
258cdf0e10cSrcweir	/** with this property you can set the minimum height for a shape with text.
259cdf0e10cSrcweir		On edit, the auto grow feature will not shrink the objects height smaller
260cdf0e10cSrcweir		than the value of this property.
261cdf0e10cSrcweir	*/
262cdf0e10cSrcweir	[property] long TextMinimumFrameHeight;
263cdf0e10cSrcweir
264cdf0e10cSrcweir	//-------------------------------------------------------------------------
265cdf0e10cSrcweir
266cdf0e10cSrcweir	/** with this property you can set the minimum width for a shape with text.
267cdf0e10cSrcweir		On edit, the auto grow feature will not shrink the object width smaller
268cdf0e10cSrcweir		than the value of this property.
269cdf0e10cSrcweir	*/
270cdf0e10cSrcweir	[property] long TextMinimumFrameWidth;
271cdf0e10cSrcweir
272cdf0e10cSrcweir	//-------------------------------------------------------------------------
273cdf0e10cSrcweir
274cdf0e10cSrcweir	/** This is the number of pixels the text is moved in each animation step.
275cdf0e10cSrcweir	 */
276cdf0e10cSrcweir	[property] short TextAnimationAmount;
277cdf0e10cSrcweir
278cdf0e10cSrcweir	//-------------------------------------------------------------------------
279cdf0e10cSrcweir
280cdf0e10cSrcweir	/** This number defines how many times the text animation is repeated.
281cdf0e10cSrcweir		<p>If this is set to zero, the repeat is endless.</p>
282cdf0e10cSrcweir	 */
283cdf0e10cSrcweir	[property] short TextAnimationCount;
284cdf0e10cSrcweir
285cdf0e10cSrcweir	//-------------------------------------------------------------------------
286cdf0e10cSrcweir
287cdf0e10cSrcweir	/** This is the delay in thousandths of a second between each
288cdf0e10cSrcweir		of the animation steps.
289cdf0e10cSrcweir	 */
290cdf0e10cSrcweir	[property] short TextAnimationDelay;
291cdf0e10cSrcweir
292cdf0e10cSrcweir	//-------------------------------------------------------------------------
293cdf0e10cSrcweir
294cdf0e10cSrcweir	/** This enumeration defines the direction in which the text moves.
295cdf0e10cSrcweir	 */
296cdf0e10cSrcweir	[property] com::sun::star::drawing::TextAnimationDirection TextAnimationDirection;
297cdf0e10cSrcweir
298cdf0e10cSrcweir	//-------------------------------------------------------------------------
299cdf0e10cSrcweir
300cdf0e10cSrcweir	/** This value defines the type of animation.
301cdf0e10cSrcweir	 */
302cdf0e10cSrcweir	[property] com::sun::star::drawing::TextAnimationKind TextAnimationKind;
303cdf0e10cSrcweir
304cdf0e10cSrcweir	//-------------------------------------------------------------------------
305cdf0e10cSrcweir
306cdf0e10cSrcweir	/** If this value is <TRUE/>, the text is visible at the start of the
307cdf0e10cSrcweir		animation.
308cdf0e10cSrcweir	 */
309cdf0e10cSrcweir	[property] boolean TextAnimationStartInside;
310cdf0e10cSrcweir
311cdf0e10cSrcweir	//-------------------------------------------------------------------------
312cdf0e10cSrcweir
313cdf0e10cSrcweir	/** If this value is <TRUE/>, the text is visible at the end of the
314cdf0e10cSrcweir		animation.
315cdf0e10cSrcweir	 */
316cdf0e10cSrcweir	[property] boolean TextAnimationStopInside;
317cdf0e10cSrcweir
318cdf0e10cSrcweir	//-------------------------------------------------------------------------
319cdf0e10cSrcweir
320cdf0e10cSrcweir	/** This value selects the writing mode for the text.
321cdf0e10cSrcweir	 */
322cdf0e10cSrcweir	[property] ::com::sun::star::text::WritingMode TextWritingMode;
323cdf0e10cSrcweir};
324cdf0e10cSrcweir
325cdf0e10cSrcweir//=============================================================================
326cdf0e10cSrcweir
327cdf0e10cSrcweir}; }; }; };
328cdf0e10cSrcweir
329cdf0e10cSrcweir#endif
330cdf0e10cSrcweir
331