ooodev.adapter.drawing.fill_properties_partial module
- class ooodev.adapter.drawing.fill_properties_partial.FillPropertiesPartial(component)[source]
Bases:
object
Partial class for FillProperties.
See also
- Parameters:
component (FillProperties) –
- __init__(component)[source]
Constructor
- Parameters:
component (FillProperties) – UNO Component that implements
com.sun.star.drawing.FillProperties
interface.- Return type:
None
- property fill_background: bool
Gets/Sets whether the transparent background of a hatch filled area is drawn in the current background color.
If this is
True
, the transparent background of a hatch filled area is drawn in the current background color.- Return type:
bool
- property fill_bitmap: XBitmap | None
Gets/Sets the bitmap used for filling.
If the property
fill_style
is set toFillStyle.BITMAP
, this is the bitmap used.optional
- Return type:
XBitmap | None
- property fill_bitmap_logical_size: bool
Gets/Sets if the size is given in percentage or as an absolute value.
If this is
True
, the propertiesfill_bitmap_size_x
andfill_bitmap_size_y
contain the size of the tile in percent of the size of the original bitmap. If this isFalse
, the size of the tile is specified with1/100th mm
.- Return type:
bool
- property fill_bitmap_mode: BitmapMode
Gets/Sets how an area is filled with a single bitmap.
This enum selects how an area is filled with a single bitmap.
This property corresponds to the properties
fill_bitmap_stretch
andfill_bitmap_tile
.If set to
BitmapMode.REPEAT
, the propertyfill_bitmap_stretch
is set toFalse
, and the propertyfill_bitmap_tile
is set toTrue
.If set to
BitmapMode.STRETCH
, the propertyfill_bitmap_stretch
is set toTrue
, and the propertyfill_bitmap_tile
is set toFalse
.If set to
BitmapMode.NO_REPEAT
, both propertiesfill_bitmap_stretch
andfill_bitmap_tile
are set toFalse
.- Returns:
Bitmap Mode
- Return type:
BitmapMode
Hint
BitmapMode
can be imported fromooo.dyn.drawing.bitmap_mode
.
- property fill_bitmap_name: str
If the property FillStyle is set to
FillStyle.BITMAP
, this is the name of the used fill bitmap style.- Return type:
str
- property fill_bitmap_offset_x: int
Gets/Sets - Every second line of tiles is moved the given percent of the width of the bitmap.
- Return type:
int
- property fill_bitmap_offset_y: int
Gets/Sets - Every second row of tiles is moved the given percent of the height of the bitmap.
- Return type:
int
- property fill_bitmap_position_offset_x: int
Gets/Sets the horizontal offset where the tile starts.
It is given in percent in relation to the width of the bitmap.
- Return type:
int
- property fill_bitmap_position_offset_y: int
Gets/Sets the vertical offset where the tile starts.
It is given in percent in relation to the height of the bitmap.
- Return type:
int
- property fill_bitmap_rectangle_point: RectanglePoint
Gets/Sets - RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.
- Returns:
RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.
- Return type:
RectanglePoint
Hint
RectanglePoint
can be imported fromooo.dyn.drawing.rectangle_point
.
- property fill_bitmap_size_x: int
Gets/Sets the width of the tile for filling.
Depending on the property
fill_bitmap_logical_size
, this is either relative or absolute.If
fill_bitmap_logical_size
isTrue
then property contain the size of the tile in percent of the size of the original bitmap; Otherwise, the size of the tile is specified with 1/100th mm.- Return type:
int
- property fill_bitmap_size_y: int
Gets/Sets the height of the tile for filling.
This is the height of the tile for filling.
Depending on the property FillBitmapLogicalSize, this is either relative or absolute.
If
fill_bitmap_logical_size
isTrue
then property contain the size of the tile in percent of the size of the original bitmap; Otherwise, the size of the tile is specified with 1/100th mm.- Return type:
int
- property fill_bitmap_stretch: bool | None
Gets/Sets if 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
fill_bitmap_mode
property can be used instead to set all supported bitmap modes.If set to
True
, the value of thefill_bitmap_mode
property changes toBitmapMode.STRETCH
. BUT: behavior is undefined, if the propertyfill_bitmap_tile
isTrue
too.If set to
False
, the value of thefill_bitmap_mode
property changes toBitmapMode.REPEAT
orBitmapMode.NO_REPEAT
, depending on the current value of thefill_bitmap_tile
property.optional
- Return type:
bool | None
- property fill_bitmap_tile: bool | None
Get/Sets 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
fill_bitmap_mode
property can be used instead to set all supported bitmap modes.If set to
True
, the value of thefill_bitmap_mode
property changes toBitmapMode.REPEAT
. BUT: behavior is undefined, if the propertyfill_bitmap_stretch
isTrue
too.If set to
False
, the value of thefill_bitmap_mode
property changes toBitmapMode.STRETCH
orBitmapMode.NO_REPEAT
, depending on the current value of thefill_bitmap_stretch
property.optional
- Return type:
bool | None
- property fill_bitmap_url: str | None
Gets/Sets the URL of the bitmap used for filling.
If the property
fill_style
is set toFillStyle.BITMAP
, this is a URL to the bitmap used.Note the new behavior 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
fill_bitmap
property.optional
- Return type:
str | None
- property fill_color: com.sun.star.util.Color
Gets/Sets the color used for filling.
If the property
fill_style
is set toFillStyle.SOLID
, this is the color used.- Return type:
Color
- property fill_gradient: GradientStructComp | None
Gets/Sets the gradient used for filling.
If the property
fill_style
is set toFillStyle.GRADIENT
, this describes the gradient used.Note when setting the gradient it can be a
GradientStructComp
or aGradient
struct.optional
- Returns:
Gradient Struct Component or None if not supported.
- Return type:
GradientStructComp | None
Hint
Gradient
can be imported fromooo.dyn.awt.gradient
.
- property fill_gradient_name: str
Gets/Sets the name of the used fill gradient style.
If the property
fill_style
is set toFillStyle.GRADIENT
, this is the name of the used fill gradient style.- Return type:
str
- property fill_hatch: HatchStructComp | None
Gets/Sets the hatch used for filling.
If the property
fill_style
is set toFillStyle.HATCH
, this describes the hatch used.optional
- Return type:
HatchStructComp | None
- property fill_hatch_name: str
Gets/Sets the name of the used fill hatch style.
If the property
fill_style
is set toFillStyle.HATCH
, this is the name of the used fill hatch style.- Return type:
str
- property fill_style: FillStyle
Gets/Sets the enumeration selects the style the area will be filled with.
- Returns:
Fill Style
- Return type:
FillStyle
Hint
FillStyle
can be imported fromooo.dyn.drawing.fill_style
.
- property fill_transparence: int
Gets/Sets the transparence of the filled area.
This property is only valid if the property
fill_style
is set toFillStyle.SOLID
.- Return type:
int
- property fill_transparence_gradient: GradientStructComp | None
Gets/Sets the transparency of the fill area as a gradient.
Note when setting the gradient it can be a
GradientStructComp
or aGradient
struct.optional
- Returns:
Gradient Struct Component or None if not supported.
- Return type:
GradientStructComp | None
Hint
Gradient
can be imported fromooo.dyn.awt.gradient
.
- property fill_transparence_gradient_name: str
Gets/Sets the name of the used transparence gradient style.
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.
- Return type:
str
- property fill_use_slide_background: bool | None
The area displays the slide background.
since
LibreOffice 7.4
optional
- Type:
If this is
True
, andfill_style
isFillStyle.NONE
- Return type:
bool | None
- property graphic_crop: GraphicCropStructComp[UnitMM100] | None
Gets/Sets the cropping of the object.
If the property
fill_bitmap_mode
is set toBitmapMode.STRETCH
, this is the cropping, otherwise it is empty.When setting the cropping it can be a
GraphicCropStructComp
or aGraphicCrop
struct.optional
- Returns:
Graphic Crop Struct Component or None if not supported.
- Return type:
GraphicCropStructComp | None
Hint
GraphicCrop
can be imported fromooo.dyn.text.graphic_crop
.