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_drawing_CaptionShape_idl__
24#define __com_sun_star_drawing_CaptionShape_idl__
25
26#ifndef __com_sun_star_drawing_Shape_idl__
27#include <com/sun/star/drawing/Shape.idl>
28#endif
29
30#ifndef __com_sun_star_drawing_Text_idl__
31#include <com/sun/star/drawing/Text.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_FillProperties_idl__
35#include <com/sun/star/drawing/FillProperties.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_LineProperties_idl__
39#include <com/sun/star/drawing/LineProperties.idl>
40#endif
41
42#ifndef __com_sun_star_drawing_ShadowProperties_idl__
43#include <com/sun/star/drawing/ShadowProperties.idl>
44#endif
45
46#ifndef __com_sun_star_drawing_RotationDescriptor_idl__
47#include <com/sun/star/drawing/RotationDescriptor.idl>
48#endif
49
50#ifndef __com_sun_star_awt_Point_idl__
51#include <com/sun/star/awt/Point.idl>
52#endif
53
54//=============================================================================
55
56 module com {  module sun {  module star {  module drawing {
57
58//=============================================================================
59
60/** The <type>CaptionShape</type> represents a rectangular drawing shape
61	with an additional set of lines. It can be used as a description for
62	a fixed point inside a drawing.
63 */
64published service CaptionShape
65{
66	/** the position and size is only used for the
67		caption area
68	*/
69	service com::sun::star::drawing::Shape;
70
71	service com::sun::star::drawing::FillProperties;
72
73	service com::sun::star::drawing::LineProperties;
74
75	service com::sun::star::drawing::ShadowProperties;
76
77	service com::sun::star::drawing::Text;
78
79	service com::sun::star::drawing::RotationDescriptor;
80
81	/** This is the radius of the caption area corners.
82	 */
83	[property] long CornerRadius;
84
85	/** The caption point property specify the position of
86		the point that is captioned. A set of lines are
87		rendered from the caption area.
88	*/
89	[property] com::sun::star::awt::Point CaptionPoint;
90
91	/** This property specifies the geometry of the line of a caption.
92
93		@see CaptionType
94	*/
95	[property] short CaptionType;
96
97	/** This property specifies if the escape angle of
98		the line of a caption is fixed or free. If this
99		is set to <false/>, the application can choose
100		the best possible angle. If not, the value in
101		<code>CaptionAngle</code> is used.
102	*/
103	[property] boolean CaptionIsFixedAngle;
104
105	/** This property specifies the escape angle of
106		the line of a caption.
107		It is only used if <code>CaptionIsFixedAngle</code>
108		is set to <true/>
109	*/
110	[property] long CaptionAngle;
111
112	/** This property specifies the distance between the
113		text area of the caption and the start of the line.
114	*/
115	[property] long CaptionGap;
116
117	/** This property specifies the escape direction for the
118		line of a caption.
119
120		@see CaptionEscapeDirection
121	*/
122	[property] long CaptionEscapeDirection;
123
124	/** If this property is <true/>, the property <code>CaptionEscapeRelative</code>
125		is used, else the property <code>CaptionEscapeAbsolute</code> is used.
126	*/
127	[property] boolean CaptionIsEscapeRelative;
128
129	/** This property specifies the relativ escape distance for
130		the line of a caption.
131	*/
132	[property] long CaptionEscapeRelative;
133
134	/** This property specifies the absolut escape distance for
135		the line of a caption.
136	*/
137	[property] long CaptionEscapeAbsolute;
138
139	/** This property specifies the length of the caption line.
140	*/
141	[property] long CaptionLineLength;
142
143	/** If this property is <true/>, the application determines
144		the best possible length for the caption line.
145	*/
146	[property] boolean CaptionIsFitLineLength;
147};
148
149//=============================================================================
150
151}; }; }; };
152
153#endif
154
155