digiKam
Signals | Public Member Functions | Protected Member Functions | List of all members
Digikam::RestorationPlugin Class Reference
+ Inheritance diagram for Digikam::RestorationPlugin:

Signals

void signalVisible (bool)
 

Public Member Functions

QList< DPluginAuthor > authors () const override
 Returns authors list for the plugin. More...
 
QStringList categories () const override
 
virtual void cleanUp ()
 
int count () const override
 
QString description () const override
 Returns a short description about the plugin. More...
 
QString details () const override
 Returns a long description about the plugin. More...
 
virtual QMap< QString, QString > extraAboutData () const
 Returns a list of extra data to show in plugin about dialog. More...
 
virtual QString extraAboutDataTitle () const
 Returns the title of data returned by extraAboiutData(). More...
 
BatchTool * findToolByName (const QString &name, QObject *const parent) const
 
bool hasVisibilityProperty () const override
 
QIcon icon () const override
 Returns an icon for the plugin. Default implementation return the system plugin icon. More...
 
QString ifaceIid () const override
 
QString iid () const override
 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". More...
 
DInfoInterface * infoIface () const
 
QString libraryFileName () const
 Returns the file name of the library for this plugin. This string is filled at run-time by plugin loader. More...
 
QString name () const override
 Returns the user-visible name of the plugin. More...
 
QStringList pluginAuthors () const
 
 RestorationPlugin (QObject *const parent=nullptr)
 
void setLibraryFileName (const QString &)
 Sets the file name of the library for this plugin. This string is filled at run-time by plugin loader. More...
 
void setShouldLoaded (bool b)
 
void setup (QObject *const) override
 
void setVisible (bool b) override
 
bool shouldLoaded () const
 
QList< BatchTool * > tools (QObject *const parent) const
 
QString version () const
 
 ~RestorationPlugin () override
 

Protected Member Functions

void addTool (BatchTool *const t)
 

Constructor & Destructor Documentation

◆ RestorationPlugin()

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

◆ ~RestorationPlugin()

Digikam::RestorationPlugin::~RestorationPlugin ( )
override

Member Function Documentation

◆ addTool()

void Digikam::DPluginBqm::addTool ( BatchTool *const  t)
protectedinherited

References Digikam::DPluginBqm::ifaceIid(), and Digikam::DPlugin::iid().

Referenced by DigikamBqmAutoCorrectionPlugin::AutoCorrectionPlugin::setup(), DigikamBqmBCGCorrectionPlugin::BCGCorrectionPlugin::setup(), DigikamBqmBWConvertPlugin::BWConvertPlugin::setup(), DigikamBqmChannelMixerPlugin::ChannelMixerPlugin::setup(), DigikamBqmColorBalancePlugin::ColorBalancePlugin::setup(), DigikamBqmConvert16To8Plugin::Convert16To8Plugin::setup(), DigikamBqmConvert8To16Plugin::Convert8To16Plugin::setup(), DigikamBqmCurvesAdjustPlugin::CurvesAdjustPlugin::setup(), DigikamBqmHSLCorrectionPlugin::HSLCorrectionPlugin::setup(), DigikamBqmIccConvertPlugin::IccConvertPlugin::setup(), DigikamBqmInvertPlugin::InvertPlugin::setup(), DigikamBqmWhiteBalancePlugin::WhiteBalancePlugin::setup(), DigikamBqmConvertToDngPlugin::ConvertToDngPlugin::setup(), DigikamBqmConvertToHeifPlugin::ConvertToHeifPlugin::setup(), DigikamBqmConvertToJp2Plugin::ConvertToJp2Plugin::setup(), DigikamBqmConvertToJpegPlugin::ConvertToJpegPlugin::setup(), DigikamBqmConvertToPgfPlugin::ConvertToPgfPlugin::setup(), DigikamBqmConvertToPngPlugin::ConvertToPngPlugin::setup(), DigikamBqmConvertToTiffPlugin::ConvertToTiffPlugin::setup(), DigikamBqmUserScriptPlugin::UserScriptPlugin::setup(), DigikamBqmBorderPlugin::BorderPlugin::setup(), DigikamBqmTexturePlugin::TexturePlugin::setup(), DigikamBqmWatermarkPlugin::WaterMarkPlugin::setup(), DigikamBqmAntiVignettingPlugin::AntiVignettingPlugin::setup(), DigikamBqmBlurPlugin::BlurPlugin::setup(), DigikamBqmHotPixelsPlugin::HotPixelsPlugin::setup(), DigikamBqmLensAutoFixPlugin::LensAutoFixPlugin::setup(), DigikamBqmLocalContrastPlugin::LocalContrastPlugin::setup(), DigikamBqmNoiseReductionPlugin::NoiseReductionPlugin::setup(), DigikamBqmRestorationPlugin::RedEyeCorrectionPlugin::setup(), setup(), DigikamBqmSharpenPlugin::SharpenPlugin::setup(), DigikamBqmColorFXPlugin::ColorFXPlugin::setup(), DigikamBqmFilmGrainPlugin::FilmGrainPlugin::setup(), DigikamBqmAssignTemplatePlugin::AssignTemplatePlugin::setup(), DigikamBqmRemoveMetadataPlugin::RemoveMetadataPlugin::setup(), DigikamBqmTimeAdjustPlugin::TimeAdjustPlugin::setup(), DigikamBqmCropPlugin::CropPlugin::setup(), DigikamBqmFlipPlugin::FlipPlugin::setup(), DigikamBqmResizePlugin::ResizePlugin::setup(), and DigikamBqmRotatePlugin::RotatePlugin::setup().

◆ authors()

QList< DPluginAuthor > Digikam::RestorationPlugin::authors ( ) const
overridevirtual

Returns authors list for the plugin.

Implements Digikam::DPlugin.

◆ categories()

QStringList Digikam::DPluginBqm::categories ( ) const
overridevirtualinherited

Return a list of batch tool group categories as strings registered in this plugin.

Implements Digikam::DPlugin.

References Digikam::BatchTool::toolGroupToString().

◆ cleanUp()

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

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

Reimplemented in DigikamGenericYFPlugin::YFPlugin, DigikamGenericVKontaktePlugin::VKontaktePlugin, DigikamGenericUnifiedPlugin::UnifiedPlugin, DigikamGenericTwitterPlugin::TwitterPlugin, DigikamGenericSmugPlugin::SmugPlugin, DigikamGenericRajcePlugin::RajcePlugin, DigikamGenericPiwigoPlugin::PiwigoPlugin, DigikamGenericPinterestPlugin::PPlugin, DigikamGenericOneDrivePlugin::ODPlugin, DigikamGenericMediaWikiPlugin::MediaWikiPlugin, DigikamGenericIpfsPlugin::IpfsPlugin, DigikamGenericINatPlugin::INatPlugin, DigikamGenericImgUrPlugin::ImgUrPlugin, DigikamGenericImageShackPlugin::ImageShackPlugin, DigikamGenericGoogleServicesPlugin::GSPlugin, DigikamGenericFlickrPlugin::FlickrPlugin, DigikamGenericFileTransferPlugin::FTPlugin, DigikamGenericFileCopyPlugin::FCPlugin, DigikamGenericFaceBookPlugin::FbPlugin, DigikamGenericDropBoxPlugin::DBPlugin, DigikamGenericBoxPlugin::BoxPlugin, DigikamGenericPresentationPlugin::PresentationPlugin, DigikamGenericPanoramaPlugin::PanoramaPlugin, DigikamGenericMjpegStreamPlugin::MjpegStreamPlugin, DigikamGenericMediaServerPlugin::MediaServerPlugin, DigikamGenericExpoBlendingPlugin::ExpoBlendingPlugin, DigikamGenericDScannerPlugin::DigitalScannerPlugin, and DigikamImageMagickDImgPlugin::DImgImageMagickPlugin.

Referenced by Digikam::DPluginLoader::cleanUp().

◆ count()

int Digikam::DPluginBqm::count ( ) const
overridevirtualinherited

Return the amount of tools registered.

Implements Digikam::DPlugin.

◆ description()

QString Digikam::RestorationPlugin::description ( ) const
overridevirtual

Returns a short description about the plugin.

Implements Digikam::DPlugin.

◆ details()

QString Digikam::RestorationPlugin::details ( ) const
overridevirtual

Returns a long description about the plugin.

Implements Digikam::DPlugin.

◆ extraAboutData()

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

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

Reimplemented in Digikam::DPluginDImg, DigikamRAWDImgPlugin::DImgRAWPlugin, DigikamPGFDImgPlugin::DImgPGFPlugin, DigikamJPEG2000DImgPlugin::DImgJPEG2000Plugin, DigikamImageMagickDImgPlugin::DImgImageMagickPlugin, and DigikamHEIFDImgPlugin::DImgHEIFPlugin.

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

◆ extraAboutDataTitle()

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

Returns the title of data returned by extraAboiutData().

Reimplemented in Digikam::DPluginDImg.

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

◆ findToolByName()

BatchTool * Digikam::DPluginBqm::findToolByName ( const QString &  name,
QObject *const  parent 
) const
inherited

Return a plugin tool instance found by name in plugin tools list for a given parent.

References Digikam::DPlugin::name(), and Digikam::DPluginBqm::tools().

◆ hasVisibilityProperty()

bool Digikam::DPluginBqm::hasVisibilityProperty ( ) const
overridevirtualinherited

Return true if plugin can be configured in setup dialog about the visibility property. Default implementation return true.

Reimplemented from Digikam::DPlugin.

◆ icon()

QIcon Digikam::RestorationPlugin::icon ( ) const
overridevirtual

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

Reimplemented from Digikam::DPlugin.

◆ ifaceIid()

QString Digikam::DPluginBqm::ifaceIid ( ) const
inlineoverridevirtualinherited

Return the plugin interface identifier.

Implements Digikam::DPlugin.

References DIGIKAM_DPLUGIN_BQM_IID.

Referenced by Digikam::DPluginBqm::addTool().

◆ iid()

QString Digikam::RestorationPlugin::iid ( ) const
overridevirtual

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".

Implements Digikam::DPlugin.

References DPLUGIN_IID.

◆ infoIface()

DInfoInterface * Digikam::DPluginBqm::infoIface ( ) const
inherited

Return the info interface instance.

References Digikam::BatchToolsFactory::infoIface(), and Digikam::BatchToolsFactory::instance().

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

QString Digikam::RestorationPlugin::name ( ) const
overridevirtual

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.

Implements Digikam::DPlugin.

◆ pluginAuthors()

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

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

References Digikam::DPlugin::authors(), and Digikam::DPluginAuthor::name.

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

void Digikam::RestorationPlugin::setup ( QObject * const  parent)
overridevirtual

Plugin factory method to create all internal object instances for a given parent.

Implements Digikam::DPlugin.

References Digikam::DPluginBqm::addTool(), and Digikam::BatchTool::setPlugin().

◆ setVisible()

void Digikam::DPluginBqm::setVisible ( bool  b)
overridevirtualinherited

Holds whether the plugin can be seen in parent view.

Implements Digikam::DPlugin.

References Digikam::DPluginBqm::signalVisible().

◆ 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(), Digikam::DPluginLoader::registerEditorPlugins(), and Digikam::DPluginLoader::registerGenericPlugins().

◆ signalVisible

void Digikam::DPluginBqm::signalVisible ( bool  )
signalinherited

Referenced by Digikam::DPluginBqm::setVisible().

◆ tools()

QList< BatchTool * > Digikam::DPluginBqm::tools ( QObject *const  parent) const
inherited

Return all plugin tools registered in setup() method with addTool() for a given parent.

Referenced by Digikam::DPluginBqm::findToolByName().

◆ 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: