summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/FillProperties.idl
blob: 0d56e06c7417d8c74c20c8b9bb674eecd975d8fe (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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: FillProperties.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 23:33:09 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_FillProperties_idl__
#define __com_sun_star_drawing_FillProperties_idl__

#ifndef __com_sun_star_drawing_FillStyle_idl__
#include <com/sun/star/drawing/FillStyle.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_awt_Gradient_idl__
#include <com/sun/star/awt/Gradient.idl>
#endif

#ifndef __com_sun_star_drawing_Hatch_idl__
#include <com/sun/star/drawing/Hatch.idl>
#endif

#ifndef __com_sun_star_drawing_BitmapMode_idl__
#include <com/sun/star/drawing/BitmapMode.idl>
#endif

#ifndef __com_sun_star_awt_XBitmap_idl__
#include <com/sun/star/awt/XBitmap.idl>
#endif

#ifndef __com_sun_star_drawing_RectanglePoint_idl__
#include <com/sun/star/drawing/RectanglePoint.idl>
#endif


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

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

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

/** This is a set of properties to describe the style for rendering an area.
 */
published service FillProperties
{
    //-------------------------------------------------------------------------
    /** This enumeration selects the style with which the area will be filled.
    */
    [property] com::sun::star::drawing::FillStyle FillStyle;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::SOLID</const>,
        this is the color used.
    */
    [property] com::sun::star::util::Color FillColor;

    //-------------------------------------------------------------------------
    /** This is the transparence of the filled area.
        
        <p>This property is only valid if <type>FillStyle</type> is set to
        <const>FillStyle::SOLID</const>.
    */
    [property] short FillTransparence;

    //-------------------------------------------------------------------------
    /** If a gradient is used for transparency, this is the name of the
        used transparence gradient style or it is empty. If you set the name
        of a transparence gradient style contained in the document, this
        style used.
    */
    [property] string FillTransparenceGradientName;


    //-------------------------------------------------------------------------
    /** This describes the transparency of the fill area as a gradient.
    */
    [optional, property] com::sun::star::awt::Gradient FillTransparenceGradient;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
        is the name of the used fill gradient style.
    */
    [property] string FillGradientName;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
        describes the gradient used.
    */
    [optional, property] com::sun::star::awt::Gradient FillGradient;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::GRADIENT</const>, this
        is the name of the used fill hatch style.
    */
    [property] string FillHatchName;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::HATCH</const>, this
        describes the hatch used.
    */
    [optional, property] com::sun::star::drawing::Hatch FillHatch;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
        the name of the used fill bitmap style.
    */
    [property] string FillBitmapName;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
        the bitmap used.
    */
    [optional, property] com::sun::star::awt::XBitmap FillBitmap;

    //-------------------------------------------------------------------------
    /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
        a URL to the bitmap used.
    */
    [optional, property] string FillBitmapURL;

    //-------------------------------------------------------------------------
    /** This is the horizontal offset where the tile starts.
        
        <p>It is given in percent in relation to the width of the bitmap.
    */
    [property] short FillBitmapOffsetX;

    //-------------------------------------------------------------------------
    /** This is the vertical offset where the tile starts.
        
        It is given in percent in relation to the width of the bitmap.
    */
    [property] short FillBitmapOffsetY;

    //-------------------------------------------------------------------------
    /** Every second line of tiles is moved the given percent of the
        witdh of the bitmap.
    */
    [property] short FillBitmapPositionOffsetX;

    //-------------------------------------------------------------------------
    /** Every second row of tiles is moved the given percent of the
        width of the bitmap.
    */
    [property] short FillBitmapPositionOffsetY;

    //-------------------------------------------------------------------------
    /** The RectanglePoint specifies the position inside of the bitmap to
        use as the top left position for rendering.
    */
    [property] com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint;

    //-------------------------------------------------------------------------
    /** specifies if the size is given in percentage or
        as an absolute value.
        
        <p>If this is <TRUE/>, the properties FillBitmapSizeX
        and  FillBitmapSizeY contain the size of the tile in percent 
        of the size of the original bitmap. If this
        is <FALSE/>, the size of the tile is specified
        with 1/100th mm.
    */
    [property] boolean FillBitmapLogicalSize;

    //-------------------------------------------------------------------------
    /** This is the width of the tile for filling. 
        
        <p>Depending on the property FillBitmapLogicalSize, this is 
        either relative or absolute.
    */
    [property] long FillBitmapSizeX;

    //-------------------------------------------------------------------------
    /** This is the height of the tile for filling. 
        
        <p>Depending on the property FillBitmapLogicalSize, this 
        is either relative or absolute.
    */
    [property] long FillBitmapSizeY;

    //-------------------------------------------------------------------------
    /** this enum selects how a area is filled with a single bitmap.
    */
    [property] com::sun::star::drawing::BitmapMode FillBitmapMode;

    //-------------------------------------------------------------------------
    /** if this is <TRUE/>, the transparent background of a
        hatch filled area is drawn in the current background color
    */
    [property] boolean FillBackground;

    //-------------------------------------------------------------------------
};

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

}; }; }; }; 

#endif