Class ShapePng

class ooodev.draw.export.shape_png.ShapePng(shape, lo_inst=None)

Bases: ShapeExportPngBase

Class for exporting current Draw page as a jpg image.

Parameters:

• shape (Any) –

• lo_inst (LoInst | None) –

__init__(shape, lo_inst=None)

Constructor

Parameters:

• shape (Any) – Shape to export as image.

• 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.

export(fnm, resolution=96)

Exports shape as jpg image.

Parameters:

• fnm (PathOrStr, optional) – Image file name.

• resolution (int, optional) – Resolution in dpi. Defaults to 96.

Events:

• EXPORTING_SHAPE_PNG Standard Export Cancel Event

• EXPORTED_SHAPE_PNG Export Event Args

Return type:

None

Note

On exporting event is Class CancelEventArgsExport. On exported event is Class EventArgsExport. Args event_data is a ExportPngT dictionary.

If fnm is not specified, the image file name is created based on the document name and page number and written to the same folder as the document.

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)

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)

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)

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)

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