ooodev.format.proto.area.fill_img_t module

protocol ooodev.format.proto.area.fill_img_t.FillImgT

Bases: StyleT, Protocol

Fill Image Protocol

Classes that implement this protocol must have the following methods / attributes:

__init__(*, bitmap=Ellipsis, name=Ellipsis, mode=Ellipsis, size=Ellipsis, position=Ellipsis, pos_offset=Ellipsis, tile_offset=Ellipsis, auto_name=Ellipsis)

Parameters:

• bitmap (XBitmap | None) –

• name (str) –

• mode (ImgStyleKind) –

• size (SizePercent | SizeMM | None) –

• position (RectanglePoint | None) –

• pos_offset (Offset | None) –

• tile_offset (OffsetColumn | OffsetRow | None) –

• auto_name (bool) –

Return type:

None

from_obj(obj: Any) → FillImgT

from_obj(obj: Any, **kwargs) → FillImgT

from_obj(**kwds)

Helper for @overload to raise when called.

from_preset(preset: PresetImageKind) → FillImgT

from_preset(preset: PresetImageKind, **kwargs) → FillImgT

from_preset(**kwds)

Helper for @overload to raise when called.

__protocol_attrs__ = {'add_event_listener', 'add_event_observer', 'apply', 'backup', 'copy', 'from_obj', 'from_preset', 'get_attrs', 'get_props', 'get_update_obj', 'has_update_obj', 'on_applied', 'on_applying', 'on_property_backed_up', 'on_property_backing_up', 'on_property_restore_set', 'on_property_restore_setting', 'on_property_set', 'on_property_set_error', 'prop_bitmap', 'prop_format_kind', 'prop_has_attribs', 'prop_has_backup', 'prop_is_offset_column', 'prop_is_offset_row', 'prop_is_size_mm', 'prop_is_size_percent', 'prop_mode', 'prop_parent', 'prop_pos_offset', 'prop_position', 'prop_size', 'prop_tile_offset', 'remove_event_listener', 'remove_event_observer', 'restore', 'set_update_obj', 'support_service', 'update'}

property prop_bitmap: XBitmap | None

Gets bitmap

Return type:

XBitmap | None

property prop_is_offset_column: bool

Gets if the offset value is a column offset.

Return type:

bool

property prop_is_offset_row: bool

Gets if the offset value is a row offset.

Return type:

bool

property prop_is_size_mm: bool

Gets if size is stored in mm units.

Return type:

bool

property prop_is_size_percent: bool

Gets if size is stored in percentage units.

Return type:

bool

property prop_mode: ImgStyleKind | None

Gets/Sets if fill image is tiled

Return type:

ImgStyleKind | None

property prop_pos_offset: Offset | None

Gets/Sets Position Offset

Return type:

Offset | None

property prop_position: RectanglePoint | None

Gets/Sets if fill image is tiled

Return type:

RectanglePoint | None

property prop_size: SizePercent | SizeMM | None

Gets/Sets if fill image is stretched

Return type:

SizePercent | SizeMM | None

property prop_tile_offset: OffsetColumn | OffsetRow | None

Gets/Sets Tile Offset

Return type:

OffsetColumn | OffsetRow | None