offapi/com/sun/star/drawing/FillProperties.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FillProperties.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_drawing_FillProperties_idl__
  31 #define __com_sun_star_drawing_FillProperties_idl__
  32
  33 #ifndef __com_sun_star_drawing_FillStyle_idl__
  34 #include <com/sun/star/drawing/FillStyle.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Gradient_idl__
  42 #include <com/sun/star/awt/Gradient.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_Hatch_idl__
  46 #include <com/sun/star/drawing/Hatch.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_drawing_BitmapMode_idl__
  50 #include <com/sun/star/drawing/BitmapMode.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_XBitmap_idl__
  54 #include <com/sun/star/awt/XBitmap.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_drawing_RectanglePoint_idl__
  58 #include <com/sun/star/drawing/RectanglePoint.idl>
  59 #endif
  60
  61
  62 //=============================================================================
  63
  64 module com { module sun { module star { module drawing {
  65
  66 //=============================================================================
  67
  68 /** This is a set of properties to describe the style for rendering an area.
  69  */
  70 published service FillProperties
  71 {
  72     //-------------------------------------------------------------------------
  73     /** This enumeration selects the style the area will be filled with.
  74     */
  75     [property] FillStyle FillStyle;
  76
  77     //-------------------------------------------------------------------------
  78     /** If the property <member>FillStyle</member> is set to <const>
  79         FillStyle::SOLID</const>, this is the color used.
  80     */
  81     [property] com::sun::star::util::Color FillColor;
  82
  83     //-------------------------------------------------------------------------
  84     /** This is the transparence of the filled area.
  85
  86         <p>This property is only valid if the property <member>FillStyle
  87         </member> is set to <const>FillStyle::SOLID</const>.
  88     */
  89     [property] short FillTransparence;
  90
  91     //-------------------------------------------------------------------------
  92     /** If a gradient is used for transparency, this is the name of the
  93         used transparence gradient style or it is empty. If you set the name
  94         of a transparence gradient style contained in the document, this
  95         style used.
  96     */
  97     [property] string FillTransparenceGradientName;
  98
  99
 100     //-------------------------------------------------------------------------
 101     /** This describes the transparency of the fill area as a gradient.
 102     */
 103     [optional, property] com::sun::star::awt::Gradient FillTransparenceGradient;
 104
 105     //-------------------------------------------------------------------------
 106     /** If the property <member>FillStyle</member> is set to <const>
 107         FillStyle::GRADIENT</const>, this is the name of the used fill
 108         gradient style.
 109     */
 110     [property] string FillGradientName;
 111
 112     //-------------------------------------------------------------------------
 113     /** If the property <member>FillStyle</member> is set to <const>
 114         FillStyle::GRADIENT</const>, this describes the gradient used.
 115     */
 116     [optional, property] com::sun::star::awt::Gradient FillGradient;
 117
 118     //-------------------------------------------------------------------------
 119     /** If the property <member>FillStyle</member> is set to <const>
 120         FillStyle::HATCH</const>, this is the name of the used fill hatch
 121         style.
 122     */
 123     [property] string FillHatchName;
 124
 125     //-------------------------------------------------------------------------
 126     /** If the property <member>FillStyle</member> is set to <const>
 127         FillStyle::HATCH</const>, this describes the hatch used.
 128     */
 129     [optional, property] Hatch FillHatch;
 130
 131     //-------------------------------------------------------------------------
 132     /** if this is <TRUE/>, the transparent background of a
 133         hatch filled area is drawn in the current background color.
 134     */
 135     [property] boolean FillBackground;
 136
 137     //-------------------------------------------------------------------------
 138     /** If the property <memebr>FillStyle</member> is set to <const>
 139         FillStyle::BITMAP</const>, this is the name of the used fill bitmap
 140         style.
 141     */
 142     [property] string FillBitmapName;
 143
 144     //-------------------------------------------------------------------------
 145     /** If the property <member>FillStyle</member> is set to <const>
 146         FillStyle::BITMAP</const>, this is the bitmap used.
 147     */
 148     [optional, property] com::sun::star::awt::XBitmap FillBitmap;
 149
 150     //-------------------------------------------------------------------------
 151     /** If the property <member>FillStyle</member> is set to <const>
 152         FillStyle::BITMAP</const>, this is a URL to the bitmap used.
 153     */
 154     [optional, property] string FillBitmapURL;
 155
 156     //-------------------------------------------------------------------------
 157     /** This is the horizontal offset where the tile starts.
 158
 159         <p>It is given in percent in relation to the width of the bitmap.</p>
 160     */
 161     [property] short FillBitmapPositionOffsetX;
 162
 163     //-------------------------------------------------------------------------
 164     /** This is the vertical offset where the tile starts.
 165
 166         <p>It is given in percent in relation to the height of the bitmap.</p>
 167     */
 168     [property] short FillBitmapPositionOffsetY;
 169
 170     //-------------------------------------------------------------------------
 171     /** Every second line of tiles is moved the given percent of the
 172         witdh of the bitmap.
 173     */
 174     [property] short FillBitmapOffsetX;
 175
 176     //-------------------------------------------------------------------------
 177     /** Every second row of tiles is moved the given percent of the
 178         height of the bitmap.
 179     */
 180     [property] short FillBitmapOffsetY;
 181
 182     //-------------------------------------------------------------------------
 183     /** The RectanglePoint specifies the position inside of the bitmap to
 184         use as the top left position for rendering.
 185     */
 186     [property] RectanglePoint FillBitmapRectanglePoint;
 187
 188     //-------------------------------------------------------------------------
 189     /** specifies if the size is given in percentage or as an absolute value.
 190
 191         <p>If this is <TRUE/>, the properties <member>FillBitmapSizeX</member>
 192         and <member>FillBitmapSizeY</member> contain the size of the tile in
 193         percent of the size of the original bitmap. If this is <FALSE/>, the
 194         size of the tile is specified with 1/100th mm.
 195     */
 196     [property] boolean FillBitmapLogicalSize;
 197
 198     //-------------------------------------------------------------------------
 199     /** This is the width of the tile for filling.
 200
 201         <p>Depending on the property <member>FillBitmapLogicalSize</member>,
 202         this is either relative or absolute.
 203     */
 204     [property] long FillBitmapSizeX;
 205
 206     //-------------------------------------------------------------------------
 207     /** This is the height of the tile for filling.
 208
 209         <p>Depending on the property <member>FillBitmapLogicalSize</member>,
 210         this is either relative or absolute.
 211     */
 212     [property] long FillBitmapSizeY;
 213
 214     //-------------------------------------------------------------------------
 215     /** this enum selects how a area is filled with a single bitmap.
 216
 217         <p>This property corresponds to the properties <member>
 218         FillBitmapStretch</member> and <member>FillBitmapTile</member>.</p>
 219
 220         <p>If set to <const>BitmapMode::REPEAT</const>, the property
 221         FillBitmapStretch is set to <FALSE/>, and the property FillBitmapTile
 222         is set to <TRUE/>.</p>
 223
 224         <p>If set to <const>BitmapMode::STRETCH</const>, the property
 225         FillBitmapStretch is set to <TRUE/>, and the property FillBitmapTile
 226         is set to <FALSE/>.</p>
 227
 228         <p>If set to <const>BitmapMode::NO_REPEAT</const>, both properties
 229         FillBitmapStretch and FillBitmapTile are set to <FALSE/>.</p>
 230     */
 231     [property] BitmapMode FillBitmapMode;
 232
 233     //-------------------------------------------------------------------------
 234     /** if set, the fill bitmap is stretched to fill the area of the shape.
 235
 236         <p>This property should not be used anymore and is included here for
 237         completeness. The <member>FillBitmapMode</member> property can be used
 238         instead to set all supported bitmap modes.</p>
 239
 240         <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
 241         to <const>BitmapMode::STRETCH</const>. BUT: behaviour is undefined, if
 242         the property <member>FillBitmapTile</member> is <TRUE/> too.</p>
 243
 244         <p>If set to <FALSE/>, the value of the FillBitmapMode property
 245         changes to <const>BitmapMode::REPEAT</const> or <const>
 246         BitmapMode::NO_REPEAT</const>, depending on the current value of the
 247         <member>FillBitmapTile</member> property.</p>
 248      */
 249     [optional, property] boolean FillBitmapStretch;
 250
 251     //-------------------------------------------------------------------------
 252     /** if set, the fill bitmap is repeated to fill the area of the shape.
 253
 254         <p>This property should not be used anymore and is included here for
 255         completeness. The <member>FillBitmapMode</member> property can be used
 256         instead to set all supported bitmap modes.</p>
 257
 258         <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
 259         to <const>BitmapMode::REPEAT</const>. BUT: behaviour is undefined, if
 260         the property <member>FillBitmapStretch</member> is <TRUE/> too.</p>
 261
 262         <p>If set to <FALSE/>, the value of the FillBitmapMode property
 263         changes to <const>BitmapMode::STRETCH</const> or <const>
 264         BitmapMode::NO_REPEAT</const>, depending on the current value of the
 265         <member>FillBitmapStretch</member> property.</p>
 266      */
 267     [optional, property] boolean FillBitmapTile;
 268
 269     //-------------------------------------------------------------------------
 270 };
 271
 272 //=============================================================================
 273
 274 }; }; }; };
 275
 276 #endif
 277