File Manager.lua

Functions

Manager.endDialog (props) Called when dialog box is being exited for whatever reason.
Manager.initPrefs () Static method for initializing preferences: both global and non-global.
Manager.prefChangeHandler (_id, _prefs, name, value) Preference change handler.
Manager.propChangeHandler (id, props, name, value) Property change handler.
Manager.sectionsForBottomOfDialog (vf, props) Create bottom section with settings.
Manager.sectionsForTopOfDialog (vf, props) Create top section of dialog.
Manager.setProp (name, value) Static method for updating display property corresponding to pref.
Manager.startDialog (props) Called when dialog box is being initialized for plugin.
Manager:_initGlobalPrefs () Initialize global preferences.
Manager:_initPrefs (presetName) Initialize local preferences for specified preset.
Manager:endDialogMethod (props) Called when dialog box is being exited for whatever reason.
Manager:new (t) Constructor for new instance.
Manager:newClass (t) Constructor for extending class.
Manager:prefChangeHandlerMethod (_id, _prefs, key, value, call) Preference change handler.
Manager:propChangeHandlerMethod (props, name, value) Plugin manager property change handler.
Manager:sectionsForBottomOfDialogMethod (vf, props) Sections for bottom of dialog method.
Manager:sectionsForTopOfDialogMethod (vf, props) Sections for top of dialog method.
Manager:startDialogMethod (props) Start dialog method.


Functions

Manager.endDialog (props)
Called when dialog box is being exited for whatever reason. Static function required by Lightroom. Derived classes should override method instead.

Parameters:

  • props:
Manager.initPrefs ()
Static method for initializing preferences: both global and non-global.

Usage:

  • Global preferences used by framework are initialized in init-framework.
    (I don't think framework is using any non-global preferences at the moment). This function is for initializing preferencea used by application.
  • Must be called from init module, so preferences are initialized without having to visit plugin manager.
  • Extended classes should always call this after initializing extended preferences. 
Manager.prefChangeHandler (_id, _prefs, name, value)
Preference change handler. Static function required by Lightroom. Derived classes should override method instead.

Parameters:

  • _id:
  • _prefs:
  • name:
  • value:
Manager.propChangeHandler (id, props, name, value)
Property change handler. Static function required by Lightroom. Derived classes should override method instead.

Parameters:

  • id:
  • props:
  • name:
  • value:
Manager.sectionsForBottomOfDialog (vf, props)
Create bottom section with settings. Static function required by Lightroom. Derived classes should override method instead.

Parameters:

  • vf:
  • props:
Manager.sectionsForTopOfDialog (vf, props)
Create top section of dialog. Static function required by Lightroom. Derived classes should override method instead.

Parameters:

  • vf:
  • props:
Manager.setProp (name, value)
Static method for updating display property corresponding to pref.

Parameters:

  • name:
  • value:
Manager.startDialog (props)
Called when dialog box is being initialized for plugin. Static function simply creates an appropriate manager instance and dispatches its start-dialog method. Derived classes should override methods, not static functions.

Parameters:

  • props:
Manager:_initGlobalPrefs ()
Initialize global preferences.
Manager:_initPrefs (presetName)
Initialize local preferences for specified preset.

Parameters:

  • presetName:
Manager:endDialogMethod (props)
Called when dialog box is being exited for whatever reason.

Typically a good place to make sure settings have been saved.

Parameters:

  • props:

Usage:

    The base method just saves everything - override to descriminate. 
Manager:new (t)
Constructor for new instance.

Parameters:

  • t:
Manager:newClass (t)
Constructor for extending class.

Parameters:

  • t:
Manager:prefChangeHandlerMethod (_id, _prefs, key, value, call)
Preference change handler.

Handles change to preferences that are associated with a property table in the plugin manager UI.
Examples: adv-dbg-ena, pref-set-name.

Parameters:

  • _id:
  • _prefs: Preferences associated with value change.
  • key: raw preference key - not suitable for direct comparison to global pref names.
  • value: New preference value.
  • call:

Usage:

  • *** IMPORTANT: The base class method is critical and must be called by derived class.
  • Changed items are typically changed via the UI and are bound directly to lr-prefs. 
    props are not bound to prefs explicitly/directly, but need to be reloaded if the pref set name changes.
Manager:propChangeHandlerMethod (props, name, value)
Plugin manager property change handler.

Parameters:

  • props:
  • name:
  • value:

Usage:

  • Handles changes to property table for UI elements that are NOT specifically/directly bound to a lr-preference.
  • By default, this method simply sets the corresponding preference which may be from a named set, or the unnamed (default) set.
  • *** IMPORTANT: Derived class may need to call base class method, or at a minimum, make sure changed prefs are set. 
Manager:sectionsForBottomOfDialogMethod (vf, props)
Sections for bottom of dialog method.

Parameters:

  • vf:
  • props:

Usage:

    *** Required for named preference set support - must be called in derived class if named preferences are to be supported and this method is overridden. 
Manager:sectionsForTopOfDialogMethod (vf, props)
Sections for top of dialog method.

Parameters:

  • vf:
  • props:

Usage:

    Derived class is free to call to include standard sections, or override completely... 
Manager:startDialogMethod (props)
Start dialog method.

Parameters:

  • props:

Usage:

    *** IMPORTANT: The base class method is critical and must be called by derived class, 
    AFTER initializing all the pref values, so they get loaded into props.

Valid XHTML 1.0!