ParaView
Public Member Functions
pqBrandPluginsLoader Class Reference

pqBrandPluginsLoader is used to load the plugins required to be loaded at the start of a ParaView-based application, if any. More...

#include <pqBrandPluginsLoader.h>

List of all members.

Public Member Functions

 pqBrandPluginsLoader (QObject *parent=0)
bool loadPlugins (const QStringList &plugins, bool skip_missing_plugins=false)
 Called at startup to load required list of plugins to be loaded on startup.

Detailed Description

pqBrandPluginsLoader is used to load the plugins required to be loaded at the start of a ParaView-based application, if any.

Given the list of plugin names, it tries to locate and load them during the application initialization process. You need to use this class only if you are writing a custom main.

Definition at line 45 of file pqBrandPluginsLoader.h.


Constructor & Destructor Documentation

pqBrandPluginsLoader::pqBrandPluginsLoader ( QObject *  parent = 0)

Member Function Documentation

bool pqBrandPluginsLoader::loadPlugins ( const QStringList &  plugins,
bool  skip_missing_plugins = false 
)

Called at startup to load required list of plugins to be loaded on startup.

Typically this method is called after the MainWindow has been created but before the event loop is started and before the GUI configuration XMLs, if any, are loaded. The argument is a list of plugin-names (without platform specific extensions or path). The locations where the plugin is searched for are as follows in the given order:

  • executable-dir (for Mac *.app, it's the app dir)
  • executable-dir/plugins/pluginname
  • *.app/Contents/Plugins/ (for Mac)

The documentation for this class was generated from the following file: