File Publish.lua
Functions
Publish:checkBeforeRendering () | Remove photos not to be rendered, or whatever. |
Publish:endDialogMethod (props) | Do whatever when dialog box closing. |
Publish:finale (service, status, message) | Perform export service wrap-up. |
Publish:newClass (t) | Constructor for extending class. |
Publish:newDialog (t) | Constructor to create the export object that represents the export dialog box. |
Publish:newExport (t) | Create a new export object. |
Publish:processRenderedPhoto (rendition, photoPath) | Process one rendered photo. |
Publish:processRenderedPhotosMethod () | Method version of like-named static function. |
Publish:processRenderingFailure (rendition, message) | Process one photo rendering failure. |
Publish:propertyChangeHandlerMethod (props, name, value) | Handle change to properties under authority of base export class. |
Publish:sectionsForBottomOfDialogMethod (vf, props) | Standard export sections for bottom of dialog. |
Publish:sectionsForTopOfDialogMethod (vf, props) | Standard export sections for top of dialog. |
Publish:service (service) | Service function of base export - processes renditions. |
Publish:startDialogMethod (props) | Do whatever when dialog box opening. |
Functions
- Publish:checkBeforeRendering ()
- Remove photos not to be rendered, or whatever.
- Publish:endDialogMethod (props)
-
Do whatever when dialog box closing.
Nuthin yet...
Parameters:
-
props
:
Usage:
Call from derived class to ensure dialog is ended properly according to base class.
-
- Publish:finale (service, status, message)
-
Perform export service wrap-up.
Parameters:
-
service
: -
status
: -
message
:
Usage:
Override this method in derived class to log stats...
*** IMPORTANT: This method is critical to export integrity. Derived export class must remember to call it at end of special export finale method.
-
- Publish:newClass (t)
-
Constructor for extending class.
Parameters:
-
t
:
-
- Publish:newDialog (t)
-
Constructor to create the export object that represents the export dialog box.
One of these objects is created when the export dialog box is presented, if it has not already been.
Parameters:
-
t
:
-
- Publish:newExport (t)
-
Create a new export object.
One of these objects is created EACH time a new export is initiated, then killed at export completion - supports multiple concurrent exports, without interference (assuming a different set of photos is selected, otherwise all kinds of interference...)
Parameters:
-
t
: Parameter table- exportContext
- functionContext
Return value:
- Publish object
-
- Publish:processRenderedPhoto (rendition, photoPath)
-
Process one rendered photo.
Parameters:
-
rendition
: -
photoPath
:
-
- Publish:processRenderedPhotosMethod ()
-
Method version of like-named static function.
Usage:
Base class implementation simply calls the export service method wrapped in an app call.
Derived export class can certainly override this method, but consider overriding the service & finale methods instead.
Called immediately after process-rendered-photos static "boot-strap" function.
- Publish:processRenderingFailure (rendition, message)
-
Process one photo rendering failure.
Parameters:
-
rendition
: -
message
: error message generated by Lightroom.
-
- Publish:propertyChangeHandlerMethod (props, name, value)
-
Handle change to properties under authority of base export class.
Presently there are none - but that could change
Parameters:
-
props
: -
name
: -
value
:
Usage:
Call from derived class to ensure base property changes are handled.
-
- Publish:sectionsForBottomOfDialogMethod (vf, props)
-
Standard export sections for bottom of dialog.
Reminder: Lightroom supports named export presets.
Parameters:
-
vf
: -
props
:
Usage:
These sections can be combined with derived class's in their entirety, or strategically - presently there are none.
-
- Publish:sectionsForTopOfDialogMethod (vf, props)
-
Standard export sections for top of dialog.
Presently seems like a good idea to replicate the plugin manager sections.
Parameters:
-
vf
: -
props
:
Usage:
These sections can be combined with derived class's in their entirety, or strategically...
-
- Publish:service (service)
-
Service function of base export - processes renditions.
You can override this method in its entirety, OR just:
- checkBeforeRendering
- processRenderedPhoto
- processRenderingFailure
- (and finale maybe)
Parameters:
-
service
:
- Publish:startDialogMethod (props)
-
Do whatever when dialog box opening.
Nuthin to do so far - but that could change.
Parameters:
-
props
:
Usage:
Call from derived class to ensure dialog is initialized according to base class.
-