Class PagePng
- class ooodev.write.export.page_png.PagePng(doc)[source]
Bases:
LoInstPropsPartial
,EventsPartial
Class for exporting current Writer page as a png image.
- Parameters:
doc (WriteDoc) –
- add_event_observers(*args)
Adds observers that gets their
trigger
method called when this classtrigger
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)[source]
Exports doc pages as png images.
- Parameters:
fnm (PathOrStr, optional) – Image file name.
resolution (int, optional) – Resolution in dpi. Defaults to 96.
- Events:
- Return type:
None
Note
On exporting event is Class CancelEventArgsExport. On exported event is Class EventArgsExport. Args
event_data
is aExportPngT
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)[source]
Add an event listener to current instance that is triggered on export complete.
- Parameters:
callback (Callable[[Any, CancelEventArgsExport[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, CancelEventArgsExport[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: