digiKam
Public Member Functions | List of all members
DigikamQImageDImgPlugin::DImgQImagePlugin Class Reference
+ Inheritance diagram for DigikamQImageDImgPlugin::DImgQImagePlugin:

Public Member Functions

QList< DPluginAuthor > authors () const override
 Returns authors list for the plugin. More...
 
int canRead (const QFileInfo &fileInfo, bool magic) const override
 
int canWrite (const QString &format) const override
 
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...
 
 DImgQImagePlugin (QObject *const parent=nullptr)
 
QMap< QString, QString > extraAboutData () const override
 
QString extraAboutDataTitle () const override
 Returns the title of data returned by extraAboiutData(). More...
 
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...
 
QString libraryFileName () const
 Returns the file name of the library for this plugin. This string is filled at run-time by plugin loader. More...
 
DImgLoader * loader (DImg *const image, const DRawDecoding &rawSettings=DRawDecoding()) const override
 
QString loaderName () const override
 
QString name () const override
 Returns the user-visible name of the plugin. More...
 
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. More...
 
void setShouldLoaded (bool b)
 
void setup (QObject *const) override
 
void setVisible (bool) override
 
bool shouldLoaded () const
 
QString typeMimes () const override
 
QString version () const
 
 ~DImgQImagePlugin () override
 

Constructor & Destructor Documentation

◆ DImgQImagePlugin()

DigikamQImageDImgPlugin::DImgQImagePlugin::DImgQImagePlugin ( QObject *const  parent = nullptr)
explicit

◆ ~DImgQImagePlugin()

DigikamQImageDImgPlugin::DImgQImagePlugin::~DImgQImagePlugin ( )
override

Member Function Documentation

◆ authors()

QList< DPluginAuthor > DigikamQImageDImgPlugin::DImgQImagePlugin::authors ( ) const
overridevirtual

Returns authors list for the plugin.

Implements Digikam::DPlugin.

◆ canRead()

int DigikamQImageDImgPlugin::DImgQImagePlugin::canRead ( const QFileInfo &  fileInfo,
bool  magic 
) const
overridevirtual

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.

Implements Digikam::DPluginDImg.

References name().

◆ canWrite()

int DigikamQImageDImgPlugin::DImgQImagePlugin::canWrite ( const QString &  format) const
overridevirtual

Return > 0 if target file format is supported by the loader and contents can be written. The return value (1 - 100) is a priority.

Implements Digikam::DPluginDImg.

◆ categories()

QStringList Digikam::DPluginDImg::categories ( ) const
inlineoverridevirtualinherited

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.

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::DPluginDImg::count ( ) const
inlineoverridevirtualinherited

This kind of plugin only provide one tool.

Implements Digikam::DPlugin.

◆ description()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::description ( ) const
overridevirtual

Returns a short description about the plugin.

Implements Digikam::DPlugin.

◆ details()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::details ( ) const
overridevirtual

Returns a long description about the plugin.

Implements Digikam::DPlugin.

◆ extraAboutData()

QMap< QString, QString > Digikam::DPluginDImg::extraAboutData ( ) const
overridevirtualinherited

With this kind of plugin, we will display the type-mimes list on about dialog.

Reimplemented from Digikam::DPlugin.

References Digikam::KeywordSearch::split(), and Digikam::DPluginDImg::typeMimes().

◆ extraAboutDataTitle()

QString Digikam::DPluginDImg::extraAboutDataTitle ( ) const
overridevirtualinherited

Returns the title of data returned by extraAboiutData().

Reimplemented from Digikam::DPlugin.

◆ hasVisibilityProperty()

bool Digikam::DPluginDImg::hasVisibilityProperty ( ) const
inlineoverridevirtualinherited

This kind of plugin do not need to be configurable

Reimplemented from Digikam::DPlugin.

◆ icon()

QIcon DigikamQImageDImgPlugin::DImgQImagePlugin::icon ( ) const
overridevirtual

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

Reimplemented from Digikam::DPlugin.

◆ ifaceIid()

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

Return the plugin interface identifier.

Implements Digikam::DPlugin.

References DIGIKAM_DPLUGIN_DIMG_IID.

◆ iid()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::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.

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

◆ loader()

DImgLoader * DigikamQImageDImgPlugin::DImgQImagePlugin::loader ( DImg *const  image,
const DRawDecoding &  rawSettings = DRawDecoding() 
) const
overridevirtual

Return the image loader instance for the DImg instance.

Implements Digikam::DPluginDImg.

◆ loaderName()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::loaderName ( ) const
overridevirtual

Return a single capitalized word to identify the format supported by the loader. Ex: jpeg => "JPG" ; tiff => "TIF", etc.

Implements Digikam::DPluginDImg.

◆ name()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::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.

Referenced by canRead().

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

◆ previewSupported()

virtual bool Digikam::DPluginDImg::previewSupported ( ) const
inlinevirtualinherited

Return true if the loader can read a preview image.

Reimplemented in DigikamHEIFDImgPlugin::DImgHEIFPlugin.

Referenced by Digikam::DImg::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()

void DigikamQImageDImgPlugin::DImgQImagePlugin::setup ( QObject * const  parent)
overridevirtual

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

Implements Digikam::DPlugin.

◆ setVisible()

void Digikam::DPluginDImg::setVisible ( bool  )
inlineoverridevirtualinherited

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

◆ typeMimes()

QString DigikamQImageDImgPlugin::DImgQImagePlugin::typeMimes ( ) const
overridevirtual

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"

Implements Digikam::DPluginDImg.

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