1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_drawing_CaptionShape_idl__
28#define __com_sun_star_drawing_CaptionShape_idl__
29
30#ifndef __com_sun_star_drawing_Shape_idl__
31#include <com/sun/star/drawing/Shape.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_Text_idl__
35#include <com/sun/star/drawing/Text.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_FillProperties_idl__
39#include <com/sun/star/drawing/FillProperties.idl>
40#endif
41
42#ifndef __com_sun_star_drawing_LineProperties_idl__
43#include <com/sun/star/drawing/LineProperties.idl>
44#endif
45
46#ifndef __com_sun_star_drawing_ShadowProperties_idl__
47#include <com/sun/star/drawing/ShadowProperties.idl>
48#endif
49
50#ifndef __com_sun_star_drawing_RotationDescriptor_idl__
51#include <com/sun/star/drawing/RotationDescriptor.idl>
52#endif
53
54#ifndef __com_sun_star_awt_Point_idl__
55#include <com/sun/star/awt/Point.idl>
56#endif
57
58//=============================================================================
59
60 module com {  module sun {  module star {  module drawing {
61
62//=============================================================================
63
64/** The <type>CaptionShape</type> represents a rectangular drawing shape
65	with an additional set of lines. It can be used as a description for
66	a fixed point inside a drawing.
67 */
68published service CaptionShape
69{
70	/** the position and size is only used for the
71		caption area
72	*/
73	service com::sun::star::drawing::Shape;
74
75	service com::sun::star::drawing::FillProperties;
76
77	service com::sun::star::drawing::LineProperties;
78
79	service com::sun::star::drawing::ShadowProperties;
80
81	service com::sun::star::drawing::Text;
82
83	service com::sun::star::drawing::RotationDescriptor;
84
85	/** This is the radius of the caption area corners.
86	 */
87	[property] long CornerRadius;
88
89	/** The caption point property specify the position of
90		the point that is captioned. A set of lines are
91		rendered from the caption area.
92	*/
93	[property] com::sun::star::awt::Point CaptionPoint;
94
95	/** This property specifies the geometry of the line of a caption.
96
97		@see CaptionType
98	*/
99	[property] short CaptionType;
100
101	/** This property specifies if the escape angle of
102		the line of a caption is fixed or free. If this
103		is set to <false/>, the application can choose
104		the best possible angle. If not, the value in
105		<code>CaptionAngle</code> is used.
106	*/
107	[property] boolean CaptionIsFixedAngle;
108
109	/** This property specifies the escape angle of
110		the line of a caption.
111		It is only used if <code>CaptionIsFixedAngle</code>
112		is set to <true/>
113	*/
114	[property] long CaptionAngle;
115
116	/** This property specifies the distance between the
117		text area of the caption and the start of the line.
118	*/
119	[property] long CaptionGap;
120
121	/** This property specifies the escape direction for the
122		line of a caption.
123
124		@see CaptionEscapeDirection
125	*/
126	[property] long CaptionEscapeDirection;
127
128	/** If this property is <true/>, the property <code>CaptionEscapeRelative</code>
129		is used, else the property <code>CaptionEscapeAbsolute</code> is used.
130	*/
131	[property] boolean CaptionIsEscapeRelative;
132
133	/** This property specifies the relativ escape distance for
134		the line of a caption.
135	*/
136	[property] long CaptionEscapeRelative;
137
138	/** This property specifies the absolut escape distance for
139		the line of a caption.
140	*/
141	[property] long CaptionEscapeAbsolute;
142
143	/** This property specifies the length of the caption line.
144	*/
145	[property] long CaptionLineLength;
146
147	/** If this property is <true/>, the application determines
148		the best possible length for the caption line.
149	*/
150	[property] boolean CaptionIsFitLineLength;
151};
152
153//=============================================================================
154
155}; }; }; };
156
157#endif
158
159