![]() |
digiKam
|
#include <dplugindimg.h>
Public Member Functions | |
virtual QList< DPluginAuthor > | authors () const =0 |
Returns authors list for the plugin. | |
virtual int | canRead (const QFileInfo &fileInfo, bool magic) const =0 |
virtual int | canWrite (const QString &format) const =0 |
QStringList | categories () const override |
virtual void | cleanUp () |
int | count () const override |
virtual QString | description () const =0 |
Returns a short description about the plugin. | |
virtual QString | details () const =0 |
Returns a long description about the plugin. | |
DPluginDImg (QObject *const parent=nullptr) | |
virtual DImgLoaderSettings * | exportWidget (const QString &format) const =0 |
QMap< QString, QStringList > | extraAboutData () const override |
QStringList | extraAboutDataRowTitles () const override |
Returns a list of extra data row titles to show in tab of plugin about dialog. | |
QString | extraAboutDataTitle () const override |
Returns the tab title of data returned by extraAboutData(). | |
virtual QString | handbookChapter () const |
virtual QString | handbookReference () const |
virtual QString | handbookSection () const |
bool | hasVisibilityProperty () const override |
virtual QIcon | icon () const |
Returns an icon for the plugin. Default implementation return the system plugin icon. | |
QString | ifaceIid () const override |
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 DImgLoader * | loader (DImg *const image, const DRawDecoding &rawSettings=DRawDecoding()) const =0 |
virtual QString | loaderName () const =0 |
virtual QString | name () const =0 |
Returns the user-visible name of the plugin. | |
QStringList | pluginAuthors () const |
virtual bool | previewSupported () 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 |
void | setVisible (bool) override |
bool | shouldLoaded () const |
virtual QString | typeMimes () const =0 |
QString | version () const |
~DPluginDImg () override=default | |
|
explicit |
Constructor with optional parent object
|
overridedefault |
Destructor
|
pure virtualinherited |
Returns authors list for the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg(), and Digikam::DPlugin::pluginAuthors().
|
pure virtual |
Return > 0 if source file path is supported by the loader and contents can be loaded. The return value (1 - 100) is a priority. digiKam default loaders have a priority of 10, the QImage loader has a priority of 80 and the ImageMagick loader has a priority of 90. If the loader is to be used before the default loader, the value must be less than 10.
Referenced by Digikam::DPluginLoader::canImport(), extraAboutData(), and Digikam::DImgStaticPriv::pluginForFile().
|
pure virtual |
Return > 0 if target file format is supported by the loader and contents can be written. The return value (1 - 100) is a priority.
Referenced by Digikam::DPluginLoader::canExport(), extraAboutData(), and Digikam::DImgStaticPriv::pluginForFormat().
|
inlineoverridevirtual |
This kind of plugin do not use a category.
Implements Digikam::DPlugin.
|
inlinevirtualinherited |
Plugin method to clean up internal created objects. This method is called by plugin loader.
|
inlineoverridevirtual |
This kind of plugin only provide one tool.
Implements Digikam::DPlugin.
|
pure virtualinherited |
Returns a short description about the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtualinherited |
Returns a long description about the plugin.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
pure virtual |
Return a new widget instance to show settings while exporting image to specified format. Return nullptr if format is not supported or if no settings widget is available for this format.
Referenced by Digikam::DPluginLoader::exportWidget().
|
overridevirtual |
With this kind of plugin, we will display the type-mimes list on about dialog.
Reimplemented from Digikam::DPlugin.
References canRead(), canWrite(), and typeMimes().
|
overridevirtual |
Returns a list of extra data row titles to show in tab of plugin about dialog.
Reimplemented from Digikam::DPlugin.
|
overridevirtual |
Returns the tab title of data returned by extraAboutData().
Reimplemented from Digikam::DPlugin.
|
virtualinherited |
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.
|
virtualinherited |
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.
|
virtualinherited |
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.
|
inlineoverridevirtual |
This kind of plugin do not need to be configurable
Reimplemented from Digikam::DPlugin.
|
virtualinherited |
Returns an icon for the plugin. Default implementation return the system plugin icon.
Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().
|
inlineoverridevirtual |
Return the plugin interface identifier.
Implements Digikam::DPlugin.
References DIGIKAM_DPLUGIN_DIMG_IID.
|
pure virtualinherited |
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().
|
inherited |
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 |
Return the image loader instance for the DImg instance.
Referenced by Digikam::DImg::load(), and Digikam::DImg::save().
|
pure virtual |
Return a single capitalized word to identify the format supported by the loader. Ex: jpeg => "JPG" ; tiff => "TIF", etc.
Referenced by Digikam::DImg::fileFormat(), and Digikam::DImg::load().
|
pure virtualinherited |
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(), Digikam::DPlugin::setLibraryFileName(), and Digikam::SetupRaw::SetupRaw().
|
inherited |
Return a list of authors as strings registered in this plugin.
References Digikam::DPlugin::authors().
|
inlinevirtual |
Return true if the loader can read a preview image.
Referenced by Digikam::DImg::load().
|
inherited |
Sets the file name of the library for this plugin. This string is filled at run-time by plugin loader.
References Digikam::DPlugin::name().
Referenced by Digikam::DPluginLoader::Private::appendPlugin().
|
inherited |
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 virtualinherited |
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().
|
inlineoverridevirtual |
This kind of plugin do not have GUI visibility attribute.
Implements Digikam::DPlugin.
|
inherited |
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().
|
pure virtual |
Return the list of white-listed type-mimes supported by the loader, as a string of file-name suffix separated by spaces. Ex: "jpeg jpg thm"
Referenced by extraAboutData(), and Digikam::DPluginConfViewDImg::loadPlugins().
|
inherited |
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().