LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
FillProperties Service Referencepublished

This is a set of properties to describe the style for rendering an area. More...

import"FillProperties.idl";

Inheritance diagram for FillProperties:
DataPointProperties Legend RegressionCurveEquation Title ChartArea ChartDataPointProperties Background CaptionShape ClosedBezierShape CustomShape Defaults EllipseShape PolyPolygonBezierShape PolyPolygonShape RectangleShape TextShape

Public Attributes

FillStyle FillStyle
 This enumeration selects the style the area will be filled with. More...
 
com::sun::star::util::Color FillColor
 If the property FillStyle is set to FillStyle::SOLID, this is the color used. More...
 
short FillTransparence
 This is the transparence of the filled area. More...
 
string FillTransparenceGradientName
 If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. More...
 
com::sun::star::awt::Gradient FillTransparenceGradient
 This describes the transparency of the fill area as a gradient. More...
 
string FillGradientName
 If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. More...
 
com::sun::star::awt::Gradient FillGradient
 If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More...
 
string FillHatchName
 If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. More...
 
Hatch FillHatch
 If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. More...
 
boolean FillBackground
 if this is TRUE, the transparent background of a hatch filled area is drawn in the current background color. More...
 
string FillBitmapName
 If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. More...
 
com::sun::star::awt::XBitmap FillBitmap
 If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. More...
 
string FillBitmapURL
 If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. More...
 
short FillBitmapPositionOffsetX
 This is the horizontal offset where the tile starts. More...
 
short FillBitmapPositionOffsetY
 This is the vertical offset where the tile starts. More...
 
short FillBitmapOffsetX
 Every second line of tiles is moved the given percent of the width of the bitmap. More...
 
short FillBitmapOffsetY
 Every second row of tiles is moved the given percent of the height of the bitmap. More...
 
RectanglePoint FillBitmapRectanglePoint
 The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More...
 
boolean FillBitmapLogicalSize
 specifies if the size is given in percentage or as an absolute value. More...
 
long FillBitmapSizeX
 This is the width of the tile for filling. More...
 
long FillBitmapSizeY
 This is the height of the tile for filling. More...
 
BitmapMode FillBitmapMode
 this enum selects how a area is filled with a single bitmap. More...
 
boolean FillBitmapStretch
 if set, the fill bitmap is stretched to fill the area of the shape. More...
 
boolean FillBitmapTile
 if set, the fill bitmap is repeated to fill the area of the shape. More...
 
com::sun::star::text::GraphicCrop GraphicCrop
 contains the cropping of the object. More...
 

Detailed Description

This is a set of properties to describe the style for rendering an area.

Developers Guide
Drawings - General Drawing Properties

Member Data Documentation

boolean FillBackground
property

if this is TRUE, the transparent background of a hatch filled area is drawn in the current background color.

com::sun::star::awt::XBitmap FillBitmap
optionalproperty

If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used.

boolean FillBitmapLogicalSize
property

specifies if the size is given in percentage or as an absolute value.

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.

BitmapMode FillBitmapMode
property

this enum selects how a area is filled with a single bitmap.

This property corresponds to the properties FillBitmapStretch and FillBitmapTile.

If set to BitmapMode::REPEAT, the property FillBitmapStretch is set to FALSE, and the property FillBitmapTile is set to TRUE.

If set to BitmapMode::STRETCH, the property FillBitmapStretch is set to TRUE, and the property FillBitmapTile is set to FALSE.

If set to BitmapMode::NO_REPEAT, both properties FillBitmapStretch and FillBitmapTile are set to FALSE.

string FillBitmapName
property

If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style.

short FillBitmapOffsetX
property

Every second line of tiles is moved the given percent of the width of the bitmap.

short FillBitmapOffsetY
property

Every second row of tiles is moved the given percent of the height of the bitmap.

short FillBitmapPositionOffsetX
property

This is the horizontal offset where the tile starts.

It is given in percent in relation to the width of the bitmap.

short FillBitmapPositionOffsetY
property

This is the vertical offset where the tile starts.

It is given in percent in relation to the height of the bitmap.

RectanglePoint FillBitmapRectanglePoint
property

The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.

long FillBitmapSizeX
property

This is the width of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

long FillBitmapSizeY
property

This is the height of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

boolean FillBitmapStretch
optionalproperty

if set, the fill bitmap is stretched to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The FillBitmapMode property can be used instead to set all supported bitmap modes.

If set to TRUE, the value of the FillBitmapMode property changes to BitmapMode::STRETCH. BUT: behavior is undefined, if the property FillBitmapTile is TRUE too.

If set to FALSE, the value of the FillBitmapMode property changes to BitmapMode::REPEAT or BitmapMode::NO_REPEAT, depending on the current value of the FillBitmapTile property.

boolean FillBitmapTile
optionalproperty

if set, the fill bitmap is repeated to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The FillBitmapMode property can be used instead to set all supported bitmap modes.

If set to TRUE, the value of the FillBitmapMode property changes to BitmapMode::REPEAT. BUT: behavior is undefined, if the property FillBitmapStretch is TRUE too.

If set to FALSE, the value of the FillBitmapMode property changes to BitmapMode::STRETCH or BitmapMode::NO_REPEAT, depending on the current value of the FillBitmapStretch property.

string FillBitmapURL
optionalproperty

If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used.

Deprecated:
as of LibreOffice 6.1, use FillBitmap

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When a URL is set, then it will load the bitmap and set the FillBitmap property.

com::sun::star::util::Color FillColor
property

If the property FillStyle is set to FillStyle::SOLID, this is the color used.

com::sun::star::awt::Gradient FillGradient
optionalproperty

If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used.

string FillGradientName
property

If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style.

Hatch FillHatch
optionalproperty

If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used.

string FillHatchName
property

If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style.

FillStyle FillStyle
property

This enumeration selects the style the area will be filled with.

short FillTransparence
property

This is the transparence of the filled area.

This property is only valid if the property FillStyle is set to FillStyle::SOLID.

com::sun::star::awt::Gradient FillTransparenceGradient
optionalproperty

This describes the transparency of the fill area as a gradient.

string FillTransparenceGradientName
property

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.

com::sun::star::text::GraphicCrop GraphicCrop
optionalproperty

contains the cropping of the object.

If the property FillBitmapMode is set to BitmapMode::STRETCH, this is the cropping, otherwise it is empty.

See also
com::sun::star::text::GraphicCrop
Since
LibreOffice 4.3

The documentation for this service was generated from the following file: