Class ShapeExportPngBase

class ooodev.draw.export.shape_export_png_base.ShapeExportPngBase(lo_inst=None)[source]

Bases: ShapeExportBase

Base class for exporting shapes as a png image.

Parameters:: lo_inst (LoInst | None) –

__init__(lo_inst=None)[source]

Constructor

Parameters:: lo_inst (LoInst, optional) – Lo Instance. Use when creating multiple documents. Defaults to None.

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

subscribe_event(event_name, callback)

Add an event listener to current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

subscribe_event_exported(callback)[source]

Add an event listener to current instance that is triggered on export complete.

Parameters:: callback (Callable[[Any, EventArgsExport[ExportPngT]], None]) – Callback of the event listener.
Return type:: None

subscribe_event_exporting(callback)[source]

Add an event listener to current instance that is triggered on exporting.

Parameters:: callback (Callable[[Any, CancelEventArgsExport[ExportPngT]], None]) – Callback of the event listener.
Return type:: None

trigger_event(event_name, event_args)

Trigger an event on current instance.

Parameters:

event_name (str) – Event Name.
event_args (EventArgsT) – Event Args.

Return type:

None

unsubscribe_event(event_name, callback)

Remove an event listener from current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

unsubscribe_event_exported(callback)[source]

Remove an event listener from current instance.

Parameters:: callback (Callable[[Any, EventArgsExport[ExportPngT]], None]) – Callback of the event listener.
Return type:: None

unsubscribe_event_exporting(callback)[source]

Remove an event listener from current instance.

Parameters:: callback (Callable[[Any, CancelEventArgsExport[ExportPngT]], None]) – Callback of the event listener.
Return type:: None

property event_observer: EventObserver

Gets/Sets The Event Observer for this instance.

Return type:: EventObserver

property lo_inst: LoInst

Lo Instance

Return type:: LoInst