User Tools

Site Tools


DzPluginMgr

Manager responsible for plugins.

More...

Inherits :

Methods

Signals

voidpluginAdded ( DzPlugin plugin )

Detailed Description

Responsible for the management of dynamically loaded libraries (aka “plugins”) that extend the features/functionality of the core application.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Request the instance via DzApp::getPluginMgr().

See Also:

Methods


void : doAboutPluginsDlg()

Shows the “About Installed Plugins” dialog.


DzPlugin : findPlugin( String pluginName )

Parameter(s):

  • pluginName - The name of the desired plugin.

Return Value:

  • The plug-in of the given type (if any), otherwise NULL.

Number : getNumPlugins()

Return Value:

  • The number of plug-ins currently loaded by DAZ Studio.

DzPlugin : getPlugin( Number which )

Parameter(s):

  • which - The index of the plug-in to get.

Return Value:

  • The plug-in at the given index in the list (if valid), otherwise NULL.

void : promptRestartRequired()

Prompts the user that a restart is required.

Since:

  • 4.22.1.215

Boolean : saveConfiguration()

Return Value:

  • true if the configuration file was saved, otherwise false.

Since:

  • 4.11.0.35

void : setPluginLoadOnStartup( DzPlugin plugin, Boolean onOff )

Sets whether or not the plug-in should load when the application starts.

Parameter(s):

  • plugin - The plugin to set whether or not to load on startup.
  • onOff - If true, the plugin should load on startup. If false, the plugin should not load on startup.

Since:

  • 4.11.0.35

Signals


void : pluginAdded( DzPlugin plugin )

TODO: Add description.