digiKam
Loading...
Searching...
No Matches
Digikam::DPluginRawImport Class Referenceabstract

#include <dpluginrawimport.h>

+ Inheritance diagram for Digikam::DPluginRawImport:

Signals

void signalDecodedImage (const Digikam::LoadingDescription &, const Digikam::DImg &)
 
void signalLoadRaw (const Digikam::LoadingDescription &)
 

Public Member Functions

virtual QList< DPluginAuthorauthors () const =0
 Returns authors list for the plugin.
 
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.
 
 DPluginRawImport (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 getRawProgram () const
 
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.
 
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 QString name () const =0
 Returns the user-visible name of the plugin.
 
QStringList pluginAuthors () const
 
virtual bool run (const QString &path, const DRawDecoding &def)=0
 
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
 
QString version () const
 
 ~DPluginRawImport () override=default
 

Constructor & Destructor Documentation

◆ DPluginRawImport()

Digikam::DPluginRawImport::DPluginRawImport ( QObject *const  parent = nullptr)
explicit

Constructor with optional parent object

◆ ~DPluginRawImport()

Digikam::DPluginRawImport::~DPluginRawImport ( )
overridedefault

Destructor

Member Function Documentation

◆ authors()

virtual QList< DPluginAuthor > Digikam::DPlugin::authors ( ) const
pure virtualinherited

Returns authors list for the plugin.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg(), and Digikam::DPlugin::pluginAuthors().

◆ categories()

QStringList Digikam::DPluginRawImport::categories ( ) const
inlineoverridevirtual

This kind of plugin do not use a category.

Implements Digikam::DPlugin.

◆ cleanUp()

virtual void Digikam::DPlugin::cleanUp ( )
inlinevirtualinherited

Plugin method to clean up internal created objects. This method is called by plugin loader.

◆ count()

int Digikam::DPluginRawImport::count ( ) const
inlineoverridevirtual

This kind of plugin only provide one tool.

Implements Digikam::DPlugin.

◆ description()

virtual QString Digikam::DPlugin::description ( ) const
pure virtualinherited

Returns a short description about the plugin.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().

◆ details()

virtual QString Digikam::DPlugin::details ( ) const
pure virtualinherited

Returns a long description about the plugin.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().

◆ extraAboutData()

virtual QMap< QString, QStringList > Digikam::DPlugin::extraAboutData ( ) const
inlinevirtualinherited

Returns a map of extra data to show in plugin about dialog.

Reimplemented in Digikam::DPluginDImg.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().

◆ extraAboutDataRowTitles()

virtual QStringList Digikam::DPlugin::extraAboutDataRowTitles ( ) const
inlinevirtualinherited

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().

◆ extraAboutDataTitle()

virtual QString Digikam::DPlugin::extraAboutDataTitle ( ) const
inlinevirtualinherited

Returns the tab title of data returned by extraAboutData().

Reimplemented in Digikam::DPluginDImg.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().

◆ getRawProgram()

QString Digikam::DPluginRawImport::getRawProgram ( ) const
virtual

Return the path to the raw program, or empty if not found.

Referenced by Digikam::SetupRaw::SetupRaw().

◆ handbookChapter()

QString Digikam::DPlugin::handbookChapter ( ) const
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.

◆ handbookReference()

QString Digikam::DPlugin::handbookReference ( ) const
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.

◆ handbookSection()

QString Digikam::DPlugin::handbookSection ( ) const
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.

◆ hasVisibilityProperty()

bool Digikam::DPlugin::hasVisibilityProperty ( ) const
virtualinherited

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.

◆ icon()

QIcon Digikam::DPlugin::icon ( ) const
virtualinherited

Returns an icon for the plugin. Default implementation return the system plugin icon.

Referenced by Digikam::DPluginAboutDlg::DPluginAboutDlg().

◆ ifaceIid()

QString Digikam::DPluginRawImport::ifaceIid ( ) const
inlineoverridevirtual

Return the plugin interface identifier.

Implements Digikam::DPlugin.

References DIGIKAM_DPLUGIN_RAWIMPORT_IID.

◆ iid()

virtual QString Digikam::DPlugin::iid ( ) const
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().

◆ libraryFileName()

QString Digikam::DPlugin::libraryFileName ( ) const
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().

◆ name()

virtual QString Digikam::DPlugin::name ( ) const
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().

◆ pluginAuthors()

QStringList Digikam::DPlugin::pluginAuthors ( ) const
inherited

Return a list of authors as strings registered in this plugin.

References Digikam::DPlugin::authors().

◆ run()

virtual bool Digikam::DPluginRawImport::run ( const QString &  path,
const DRawDecoding def 
)
pure virtual

Function to re-implement used to invoke Raw processor for a Raw file path and a Default Raw decoding settings.

Referenced by Digikam::EditorCore::load().

◆ setLibraryFileName()

void Digikam::DPlugin::setLibraryFileName ( const QString &  name)
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().

◆ setShouldLoaded()

void Digikam::DPlugin::setShouldLoaded ( bool  b)
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().

◆ setup()

virtual void Digikam::DPlugin::setup ( QObject *const  parent)
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().

◆ setVisible()

void Digikam::DPluginRawImport::setVisible ( bool  )
inlineoverridevirtual

This kind of plugin do not have GUI visibility attribute.

Implements Digikam::DPlugin.

◆ shouldLoaded()

bool Digikam::DPlugin::shouldLoaded ( ) const
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().

◆ signalDecodedImage

void Digikam::DPluginRawImport::signalDecodedImage ( const Digikam::LoadingDescription ,
const Digikam::DImg  
)
signal

Signal emitted to notify host application to load pre-decoded Raw preprocessed with these decoding settings.

◆ signalLoadRaw

void Digikam::DPluginRawImport::signalLoadRaw ( const Digikam::LoadingDescription )
signal

Signal emitted to notify host application to load Raw with these decoding settings.

◆ version()

QString Digikam::DPlugin::version ( ) const
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().


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