summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/CaptionShape.idl
blob: b904af702b5ea4a01ddef71007f332ea430f4e74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: CaptionShape.idl,v $
 * $Revision: 1.6 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_CaptionShape_idl__
#define __com_sun_star_drawing_CaptionShape_idl__

#ifndef __com_sun_star_drawing_Shape_idl__
#include <com/sun/star/drawing/Shape.idl>
#endif

#ifndef __com_sun_star_drawing_Text_idl__
#include <com/sun/star/drawing/Text.idl>
#endif

#ifndef __com_sun_star_drawing_FillProperties_idl__
#include <com/sun/star/drawing/FillProperties.idl>
#endif

#ifndef __com_sun_star_drawing_LineProperties_idl__
#include <com/sun/star/drawing/LineProperties.idl>
#endif

#ifndef __com_sun_star_drawing_ShadowProperties_idl__
#include <com/sun/star/drawing/ShadowProperties.idl>
#endif

#ifndef __com_sun_star_drawing_RotationDescriptor_idl__
#include <com/sun/star/drawing/RotationDescriptor.idl>
#endif

#ifndef __com_sun_star_awt_Point_idl__
#include <com/sun/star/awt/Point.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module drawing {

//=============================================================================

/** The <type>CaptionShape</type> represents a rectangular drawing shape
    with an additional set of lines. It can be used as a description for
    a fixed point inside a drawing.
 */
published service CaptionShape
{
    /** the position and size is only used for the
        caption area
    */
    service com::sun::star::drawing::Shape;

    service com::sun::star::drawing::FillProperties;

    service com::sun::star::drawing::LineProperties;

    service com::sun::star::drawing::ShadowProperties;

    service com::sun::star::drawing::Text;

    service com::sun::star::drawing::RotationDescriptor;

    /** This is the radius of the caption area corners.
     */
    [property] long CornerRadius;

    /** The caption point property specify the position of
        the point that is captioned. A set of lines are
        rendered from the caption area.
    */
    [property] com::sun::star::awt::Point CaptionPoint;

    /** This property specifies the geometry of the line of a caption.

        @see CaptionType
    */
    [property] short CaptionType;

    /** This property specifies if the escape angle of
        the line of a caption is fixed or free. If this
        is set to <false/>, the application can choose
        the best possible angle. If not, the value in
        <code>CaptionAngle</code> is used.
    */
    [property] boolean CaptionIsFixedAngle;

    /** This property specifies the escape angle of
        the line of a caption.
        It is only used if <code>CaptionIsFixedAngle</code>
        is set to <true/>
    */
    [property] long CaptionAngle;

    /** This property specifies the distance between the
        text area of the caption and the start of the line.
    */
    [property] long CaptionGap;

    /** This property specifies the escape direction for the
        line of a caption.

        @see CaptionEscapeDirection
    */
    [property] long CaptionEscapeDirection;

    /** If this property is <true/>, the property <code>CaptionEscapeRelative</code>
        is used, else the property <code>CaptionEscapeAbsolute</code> is used.
    */
    [property] boolean CaptionIsEscapeRelative;

    /** This property specifies the relativ escape distance for
        the line of a caption.
    */
    [property] long CaptionEscapeRelative;

    /** This property specifies the absolut escape distance for
        the line of a caption.
    */
    [property] long CaptionEscapeAbsolute;

    /** This property specifies the length of the caption line.
    */
    [property] long CaptionLineLength;

    /** If this property is <true/>, the application determines
        the best possible length for the caption line.
    */
    [property] boolean CaptionIsFitLineLength;
};

//=============================================================================

}; }; }; };

#endif