summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/FillProperties.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/drawing/FillProperties.idl')
-rw-r--r--offapi/com/sun/star/drawing/FillProperties.idl141
1 files changed, 96 insertions, 45 deletions
diff --git a/offapi/com/sun/star/drawing/FillProperties.idl b/offapi/com/sun/star/drawing/FillProperties.idl
index 47749376a7d5..9aaedfed601f 100644
--- a/offapi/com/sun/star/drawing/FillProperties.idl
+++ b/offapi/com/sun/star/drawing/FillProperties.idl
@@ -70,21 +70,21 @@ module com { module sun { module star { module drawing {
published service FillProperties
{
//-------------------------------------------------------------------------
- /** This enumeration selects the style with which the area will be filled.
+ /** This enumeration selects the style the area will be filled with.
*/
- [property] com::sun::star::drawing::FillStyle FillStyle;
+ [property] FillStyle FillStyle;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::SOLID</const>,
- this is the color used.
+ /** If the property <member>FillStyle</member> 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>.
+ <p>This property is only valid if the property <member>FillStyle
+ </member> is set to <const>FillStyle::SOLID</const>.
*/
[property] short FillTransparence;
@@ -103,117 +103,168 @@ published service FillProperties
[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.
+ /** If the property <member>FillStyle</member> 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.
+ /** If the property <member>FillStyle</member> 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.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::HATCH</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.
+ /** If the property <member>FillStyle</member> is set to <const>
+ FillStyle::HATCH</const>, this describes the hatch used.
*/
- [optional, property] com::sun::star::drawing::Hatch FillHatch;
+ [optional, property] Hatch FillHatch;
//-------------------------------------------------------------------------
- /** If the <type>FillStyle</type> is set to <const>FillStyle::BITMAP</const>, this is
- the name of the used fill bitmap style.
+ /** if this is <TRUE/>, the transparent background of a
+ hatch filled area is drawn in the current background color.
+ */
+ [property] boolean FillBackground;
+
+ //-------------------------------------------------------------------------
+ /** If the property <memebr>FillStyle</member> 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.
+ /** If the property <member>FillStyle</member> 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.
+ /** If the property <member>FillStyle</member> 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.
+ <p>It is given in percent in relation to the width of the bitmap.</p>
*/
- [property] short FillBitmapOffsetX;
+ [property] short FillBitmapPositionOffsetX;
//-------------------------------------------------------------------------
/** This is the vertical offset where the tile starts.
- It is given in percent in relation to the width of the bitmap.
+ <p>It is given in percent in relation to the height of the bitmap.</p>
*/
- [property] short FillBitmapOffsetY;
+ [property] short FillBitmapPositionOffsetY;
//-------------------------------------------------------------------------
/** Every second line of tiles is moved the given percent of the
witdh of the bitmap.
*/
- [property] short FillBitmapPositionOffsetX;
+ [property] short FillBitmapOffsetX;
//-------------------------------------------------------------------------
/** Every second row of tiles is moved the given percent of the
- width of the bitmap.
+ height of the bitmap.
*/
- [property] short FillBitmapPositionOffsetY;
+ [property] short FillBitmapOffsetY;
//-------------------------------------------------------------------------
/** 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;
+ [property] RectanglePoint FillBitmapRectanglePoint;
//-------------------------------------------------------------------------
- /** specifies if the size is given in percentage or
- as an absolute value.
+ /** 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.
+ <p>If this is <TRUE/>, the properties <member>FillBitmapSizeX</member>
+ and <member>FillBitmapSizeY</member> 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.
+ <p>Depending on the property <member>FillBitmapLogicalSize</member>,
+ 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.
+ <p>Depending on the property <member>FillBitmapLogicalSize</member>,
+ this is either relative or absolute.
*/
[property] long FillBitmapSizeY;
//-------------------------------------------------------------------------
/** this enum selects how a area is filled with a single bitmap.
+
+ <p>This property corresponds to the properties <member>
+ FillBitmapStretch</member> and <member>FillBitmapTile</member>.</p>
+
+ <p>If set to <const>BitmapMode::REPEAT</const>, the property
+ FillBitmapStretch is set to <FALSE/>, and the property FillBitmapTile
+ is set to <TRUE/>.</p>
+
+ <p>If set to <const>BitmapMode::STRETCH</const>, the property
+ FillBitmapStretch is set to <TRUE/>, and the property FillBitmapTile
+ is set to <FALSE/>.</p>
+
+ <p>If set to <const>BitmapMode::NO_REPEAT</const>, both properties
+ FillBitmapStretch and FillBitmapTile are set to <FALSE/>.</p>
*/
- [property] com::sun::star::drawing::BitmapMode FillBitmapMode;
+ [property] BitmapMode FillBitmapMode;
//-------------------------------------------------------------------------
- /** if this is <TRUE/>, the transparent background of a
- hatch filled area is drawn in the current background color
- */
- [property] boolean FillBackground;
+ /** if set, the fill bitmap is stretched to fill the area of the shape.
+
+ <p>This property should not be used anymore and is included here for
+ completeness. The <member>FillBitmapMode</member> property can be used
+ instead to set all supported bitmap modes.</p>
+
+ <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
+ to <const>BitmapMode::STRETCH</const>. BUT: behaviour is undefined, if
+ the property <member>FillBitmapTile</member> is <TRUE/> too.</p>
+
+ <p>If set to <FALSE/>, the value of the FillBitmapMode property
+ changes to <const>BitmapMode::REPEAT</const> or <const>
+ BitmapMode::NO_REPEAT</const>, depending on the current value of the
+ <member>FillBitmapTile</member> property.</p>
+ */
+ [optional, property] boolean FillBitmapStretch;
+
+ //-------------------------------------------------------------------------
+ /** if set, the fill bitmap is repeated to fill the area of the shape.
+
+ <p>This property should not be used anymore and is included here for
+ completeness. The <member>FillBitmapMode</member> property can be used
+ instead to set all supported bitmap modes.</p>
+
+ <p>If set to <TRUE/>, the value of the FillBitmapMode property changes
+ to <const>BitmapMode::REPEAT</const>. BUT: behaviour is undefined, if
+ the property <member>FillBitmapStretch</member> is <TRUE/> too.</p>
+
+ <p>If set to <FALSE/>, the value of the FillBitmapMode property
+ changes to <const>BitmapMode::STRETCH</const> or <const>
+ BitmapMode::NO_REPEAT</const>, depending on the current value of the
+ <member>FillBitmapStretch</member> property.</p>
+ */
+ [optional, property] boolean FillBitmapTile;
//-------------------------------------------------------------------------
};
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-25 16:47:24 +0000