|
QStringList | getCustomWidgetPaths () const override |
|
QString | getHelpFile () const override |
|
QString | getPackageURI () const override |
|
const WorkspacePlugin::PreviousVersionNameMap & | getPreviousNames () const override |
|
bool | setup () override |
|
bool | setupAuthenticationProvider (Authentication::ProviderManager &manager) override |
|
bool | setupSchedulerProvider (DataExecution::SchedulerProviderManager &manager) override |
|
| WorkspacePlugin (const QString &name, const QString &displayName, const QString &version, const QString &buildDescription=QString::null) |
|
| WorkspacePlugin (const QString &name, const QString &displayName, int versionMajor, int versionMinor, int versionRevision, const QString &buildDescription=QString::null) |
|
virtual | ~WorkspacePlugin () |
|
virtual PluginConfig & | createPluginConfig () |
|
virtual PluginMenu & | createPluginMenu () |
|
const QString & | getBuildDescription () const |
|
virtual QStringList | getCustomWidgetPaths () const |
|
virtual const DataExecution::DataFactory * | getDataFactory (const QString &dataType) const |
|
const DataExecution::DataFactory * | getDataFactory (size_type index) const |
|
virtual QString | getDefaultHelpPagePath () const |
|
virtual QString | getDefaultIconPath () const |
|
virtual WorkspacePluginList | getDependencies () const |
|
const QString & | getDisplayName () const |
|
virtual QString | getHelpFile () const |
|
const QString & | getLibraryFileName () const |
|
virtual QStringList | getLicensePaths () const |
|
const QString & | getName () const |
|
size_type | getNumDataFactories () const |
|
size_type | getNumOperationFactories () const |
|
size_type | getNumWidgetFactories () const |
|
virtual const DataExecution::OperationFactory * | getOperationFactory (const QString &opType, bool ignoreAliasedOperations=false) const |
|
const DataExecution::OperationFactory * | getOperationFactory (size_type index) const |
|
virtual QString | getPackageURI () const |
|
virtual const PreviousVersionNameMap & | getPreviousNames () const |
|
const QString & | getVersion () const |
|
const Widgets::WidgetFactory * | getWidgetFactory (size_type index) const |
|
virtual bool | isVisible () const |
|
void | logText (const QString &message) |
|
virtual void | onWorkspaceClose () |
|
void | setLibraryFileName (const QString &fileName) |
|
virtual bool | setup ()=0 |
|
virtual bool | setupAuthenticationProvider (Authentication::ProviderManager &manager) |
|
virtual bool | setupSchedulerProvider (DataExecution::SchedulerProviderManager &manager) |
|
void | showHelp (const QMap< QString, QUrl > &links, const QString &keyword="") |
|
void | showHelp (const QString &keyword) |
|
void | showHelp (const QUrl &url) |
|
bool | wasPreviouslyNamed (const QString &oldName) const |
|
The built-in plugin supplies the built-in data types and operations, along with their associated factories. The workspace application always loads this as the first plugin factory. Any application using the workspace as a shared library must also load the built-in plugin as the first one. All other plugins can assume that the built-in plugin has been loaded when they are themselves created.
- Returns
- A list of additional path prefixes to use when searching for custom .ui files when creating widgets for operation, inputs and outputs.
The custom widget paths would normally be specified using the "widgets" resource search path. A typical example would be something like widgets:MyPluginPath
where MyPluginPath
would be an area below which you put all your plugin's custom widget .ui files
. If you use the widgets:
prefix instead of just an ordinary (absolute or relative) file path, then the paths you specify will be interpretted as being relative to the application's default search paths. This is normally what you want, since plugins should generally install their custom .ui
files in their own directory below the common widgets
directory in the install area. This directory structuring is used by both the widget style sheets (in the styles
directory) and by the custom widget .ui
files.
If you follow the directory structure recommended above, then your .ui files should be found without having to do anything else. When a plugin is loaded by the PluginManager, it looks at the directory in which the plugin was located and it searches for a widgets directory related to that location. See PluginManager::loadPlugin() for more details about this directory structure.
- See also
- WidgetManager::createWidget()
Reimplemented from WorkspacePlugin.
QString getHelpFile |
( |
| ) |
const |
|
overridevirtual |
- Returns
- The path to the .qch file for the plugin, or an empty string if no help file is associated with the plugin.
The help file name would normally be specified using the "help" resource search path. A typical example would be something like help:MyPluginPath/somefile.qch
where MyPluginPath
would be an area below which you put all your plugin's help files, examples, etc. If you use the help:
prefix instead of just an ordinary (absolute or relative) file path, then the path you specify will be interpretted as being relative to the application's default search paths. This is normally what you want, since plugins should generally install their help files in their own directory below the common doc
directory in the install area.
Reimplemented from WorkspacePlugin.