![]() |
digiKam
|
#include <dplugin.h>
Public Member Functions | |
virtual QList< DPluginAuthor > | authors () const =0 |
Returns authors list for the plugin. | |
virtual QStringList | categories () const =0 |
virtual void | cleanUp () |
virtual int | count () const =0 |
virtual QString | description () const =0 |
Returns a short description about the plugin. | |
virtual QString | details () const =0 |
Returns a long description about the plugin. | |
DPlugin (QObject *const parent=nullptr) | |
virtual QMap< QString, QStringList > | extraAboutData () const |
Returns a map of extra data to show in plugin about dialog. | |
virtual QStringList | extraAboutDataRowTitles () const |
Returns a list of extra data row titles to show in tab of plugin about dialog. | |
virtual QString | extraAboutDataTitle () const |
Returns the tab title of data returned by extraAboutData(). | |
virtual QString | handbookChapter () const |
virtual QString | handbookReference () const |
virtual QString | handbookSection () const |
virtual bool | hasVisibilityProperty () const |
virtual QIcon | icon () const |
Returns an icon for the plugin. Default implementation return the system plugin icon. | |
virtual QString | ifaceIid () const =0 |
Returns the unique top level internal identification property of the plugin interface. Must be formatted as "org.kde.digikam._NAME_OF_INTERFACE_/_VERSION_". Examples: "org.kde.digikam.DPluginGeneric/1.1.0" "org.kde.digikam.DPluginEditor/1.1.0" "org.kde.digikam.DPluginBqm/1.1.0". | |
virtual QString | iid () const =0 |
Returns the unique internal identification property of the plugin. Must be formatted as "org.kde.digikam.plugin._PLUGIN_TYPE_._NAME_OF_PLUGIN_". Examples: "org.kde.digikam.plugin.generic.Calendar" "org.kde.digikam.plugin.editor.AdjustCurvesTool" "org.kde.digikam.plugin.bqm.NoiseReduction". | |
QString | libraryFileName () const |
Returns the file name of the library for this plugin. This string is filled at run-time by plugin loader. | |
virtual QString | name () const =0 |
Returns the user-visible name of the plugin. | |
QStringList | pluginAuthors () const |
void | setLibraryFileName (const QString &) |
Sets the file name of the library for this plugin. This string is filled at run-time by plugin loader. | |
void | setShouldLoaded (bool b) |
virtual void | setup (QObject *const parent)=0 |
virtual void | setVisible (bool b)=0 |
bool | shouldLoaded () const |
QString | version () const |
~DPlugin () override | |
A digiKam external plugin abstract class.
|
explicit |
Constructor with optional parent object
|
override |
Destructor
|
pure virtual |
Returns authors list for the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg(), and pluginAuthors().
|
pure virtual |
Return a list of categories as strings registered in this plugin.
Implemented in Digikam::DPluginDImg, Digikam::DPluginEditor, Digikam::DPluginGeneric, Digikam::DPluginRawImport, and Digikam::DPluginBqm.
|
inlinevirtual |
Plugin method to clean up internal created objects. This method is called by plugin loader.
|
pure virtual |
Return the amount of tools registered to all parents.
Implemented in Digikam::DPluginDImg, Digikam::DPluginEditor, Digikam::DPluginGeneric, Digikam::DPluginRawImport, and Digikam::DPluginBqm.
|
pure virtual |
Returns a short description about the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtual |
Returns a long description about the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
inlinevirtual |
Returns a map of extra data to show in plugin about dialog.
Reimplemented in Digikam::DPluginDImg.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
inlinevirtual |
Returns a list of extra data row titles to show in tab of plugin about dialog.
Reimplemented in Digikam::DPluginDImg.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
inlinevirtual |
Returns the tab title of data returned by extraAboutData().
Reimplemented in Digikam::DPluginDImg.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
virtual |
Return the online handbook chapter from an handbook section corresponding to this plugin. It's used in plugin dialog Help button. By default, no chapter is defined, and root page of the section is loaded by Help Button in this case. Note: a chapter is always included in a section. See handbookSection() for details.
|
virtual |
Return the online handbook reference from an handbook chapter corresponding to this plugin. It's used in plugin dialog Help button. By default, no reference is defined, and root page of the chapter is loaded by Help Button in this case. Note: a reference is always included in a chapter. See handbookChapter() for details.
|
virtual |
Return the online handbook section corresponding to this plugin. It's used in plugin dialog Help button. By default, no section is defined, and root page of the documentation is loaded by Help Button in this case.
|
virtual |
Return true if plugin can be configured in setup dialog about the visibility property. Default implementation return true.
Reimplemented in Digikam::DPluginDImg, and Digikam::DPluginBqm.
|
virtual |
Returns an icon for the plugin. Default implementation return the system plugin icon.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtual |
Returns the unique top level internal identification property of the plugin interface. Must be formatted as "org.kde.digikam._NAME_OF_INTERFACE_/_VERSION_". Examples: "org.kde.digikam.DPluginGeneric/1.1.0" "org.kde.digikam.DPluginEditor/1.1.0" "org.kde.digikam.DPluginBqm/1.1.0".
Implemented in Digikam::DPluginDImg, Digikam::DPluginEditor, Digikam::DPluginGeneric, Digikam::DPluginRawImport, and Digikam::DPluginBqm.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtual |
Returns the unique internal identification property of the plugin. Must be formatted as "org.kde.digikam.plugin._PLUGIN_TYPE_._NAME_OF_PLUGIN_". Examples: "org.kde.digikam.plugin.generic.Calendar" "org.kde.digikam.plugin.editor.AdjustCurvesTool" "org.kde.digikam.plugin.bqm.NoiseReduction".
Referenced by Digikam::DPluginEditor::addAction(), Digikam::DPluginGeneric::addAction(), Digikam::DPluginBqm::addTool(), Digikam::DPluginLoader::Private::appendPlugin(), Digikam::DPluginAboutDlg::DPluginAboutDlg(), Digikam::EditorCore::load(), and Digikam::SetupRaw::SetupRaw().
QString Digikam::DPlugin::libraryFileName | ( | ) | const |
Returns the file name of the library for this plugin. This string is filled at run-time by plugin loader.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtual |
Returns the user-visible name of the plugin.
The user-visible name should be context free, i.e. the name should provide enough information as to what the plugin is about in the context of digiKam.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg(), Digikam::DPluginEditor::findActionByName(), Digikam::DPluginGeneric::findActionByName(), Digikam::DPluginBqm::findToolByName(), setLibraryFileName(), and Digikam::SetupRaw::SetupRaw().
QStringList Digikam::DPlugin::pluginAuthors | ( | ) | const |
Return a list of authors as strings registered in this plugin.
References authors().
void Digikam::DPlugin::setLibraryFileName | ( | const QString & | name | ) |
Sets the file name of the library for this plugin. This string is filled at run-time by plugin loader.
References name().
Referenced by Digikam::DPluginLoader::Private::appendPlugin().
void Digikam::DPlugin::setShouldLoaded | ( | bool | b | ) |
Accessor to adjust the should loaded plugin property. This property is adjusted by plugin loader at start-up.
Referenced by Digikam::DPluginLoader::Private::appendPlugin().
|
pure virtual |
Plugin factory method to create all internal object instances for a given parent.
Referenced by Digikam::DPluginLoader::registerEditorPlugins(), Digikam::DPluginLoader::registerGenericPlugins(), and Digikam::DPluginLoader::registerRawImportPlugins().
|
pure virtual |
Holds whether the plugin can be seen in parent view.
Implemented in Digikam::DPluginEditor, Digikam::DPluginGeneric, Digikam::DPluginBqm, Digikam::DPluginDImg, and Digikam::DPluginRawImport.
bool Digikam::DPlugin::shouldLoaded | ( | ) | const |
Return the should loaded property. If it's true, the plugin must be loaded in application GUI at startup by plugin loader.
Referenced by Digikam::ToolsListView::addTool().
QString Digikam::DPlugin::version | ( | ) | const |
Return the internal version used to check the binary compatibility at run-time. This is typically the same version of digiKam core used at compilation time.
Referenced by Digikam::DPluginLoader::Private::appendPlugin(), and Digikam::DPluginAboutDlg::DPluginAboutDlg().