DigikamGenericFileCopyPlugin::FCPlugin Class Reference

Inheritance diagram for DigikamGenericFileCopyPlugin::FCPlugin:

Public Member Functions
QList< DPluginAction * >	actions (QObject *const parent) const
QList< DPluginAuthor >	authors () const override
	Returns authors list for the plugin. More...
QStringList	categories () const override
void	cleanUp () override
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...
	FCPlugin (QObject *const parent=nullptr)
DPluginAction *	findActionByName (const QString &name, QObject *const parent) const
virtual bool	hasVisibilityProperty () const
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...
QString	name () const override
	Returns the user-visible name of the plugin. More...
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. More...
void	setShouldLoaded (bool b)
void	setup (QObject *const) override
void	setVisible (bool b) override
bool	shouldLoaded () const
QString	version () const
	~FCPlugin () override

Protected Member Functions
void	addAction (DPluginAction *const ac)
DInfoInterface *	infoIface (QObject *const ac) const
bool	reactivateToolDialog (QWidget *const dlg) const

Constructor & Destructor Documentation

FCPlugin()

DigikamGenericFileCopyPlugin::FCPlugin::FCPlugin ( QObject *const  parent = nullptr )

explicit

~FCPlugin()

DigikamGenericFileCopyPlugin::FCPlugin::~FCPlugin ( )

override

Member Function Documentation

actions()

QList< DPluginAction * > Digikam::DPluginGeneric::actions ( QObject *const  parent ) const

inherited

Return all plugin actions registered in setup() method with addAction() for a given parent.

References Digikam::DPluginAction::pluginActionLessThan().

Referenced by Digikam::DPluginGeneric::findActionByName(), Digikam::DPluginLoader::pluginAction(), Digikam::DPluginLoader::pluginActions(), and Digikam::DPluginLoader::pluginsActions().

addAction()

void Digikam::DPluginGeneric::addAction ( DPluginAction *const  ac )

protectedinherited

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

Referenced by DigikamGenericDScannerPlugin::DigitalScannerPlugin::setup(), DigikamGenericGeolocationEditPlugin::GeolocationEditPlugin::setup(), DigikamGenericMetadataEditPlugin::MetadataEditPlugin::setup(), DigikamGenericTimeAdjustPlugin::TimeAdjustPlugin::setup(), DigikamGenericCalendarPlugin::CalendarPlugin::setup(), DigikamGenericDNGConverterPlugin::DNGConverterPlugin::setup(), DigikamGenericExpoBlendingPlugin::ExpoBlendingPlugin::setup(), DigikamGenericHtmlGalleryPlugin::HtmlGalleryPlugin::setup(), DigikamGenericJAlbumPlugin::JAlbumPlugin::setup(), DigikamGenericMediaServerPlugin::MediaServerPlugin::setup(), DigikamGenericMjpegStreamPlugin::MjpegStreamPlugin::setup(), DigikamGenericPanoramaPlugin::PanoramaPlugin::setup(), DigikamGenericPrintCreatorPlugin::PrintCreatorPlugin::setup(), DigikamGenericSendByMailPlugin::SendByMailPlugin::setup(), DigikamGenericVideoSlideShowPlugin::VideoSlideShowPlugin::setup(), DigikamGenericWallpaperPlugin::WallpaperPlugin::setup(), DigikamGenericGLViewerPlugin::GLViewerPlugin::setup(), DigikamGenericPresentationPlugin::PresentationPlugin::setup(), DigikamGenericSlideShowPlugin::SlideShowPlugin::setup(), DigikamGenericBoxPlugin::BoxPlugin::setup(), DigikamGenericDropBoxPlugin::DBPlugin::setup(), DigikamGenericFaceBookPlugin::FbPlugin::setup(), setup(), DigikamGenericFileTransferPlugin::FTPlugin::setup(), DigikamGenericFlickrPlugin::FlickrPlugin::setup(), DigikamGenericGoogleServicesPlugin::GSPlugin::setup(), DigikamGenericImageShackPlugin::ImageShackPlugin::setup(), DigikamGenericImgUrPlugin::ImgUrPlugin::setup(), DigikamGenericINatPlugin::INatPlugin::setup(), DigikamGenericIpfsPlugin::IpfsPlugin::setup(), DigikamGenericMediaWikiPlugin::MediaWikiPlugin::setup(), DigikamGenericOneDrivePlugin::ODPlugin::setup(), DigikamGenericPinterestPlugin::PPlugin::setup(), DigikamGenericPiwigoPlugin::PiwigoPlugin::setup(), DigikamGenericRajcePlugin::RajcePlugin::setup(), DigikamGenericSmugPlugin::SmugPlugin::setup(), DigikamGenericTwitterPlugin::TwitterPlugin::setup(), DigikamGenericUnifiedPlugin::UnifiedPlugin::setup(), DigikamGenericVKontaktePlugin::VKontaktePlugin::setup(), and DigikamGenericYFPlugin::YFPlugin::setup().

authors()

QList< DPluginAuthor > DigikamGenericFileCopyPlugin::FCPlugin::authors ( ) const

overridevirtual

Returns authors list for the plugin.

Implements Digikam::DPlugin.

categories()

QStringList Digikam::DPluginGeneric::categories ( ) const

overridevirtualinherited

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

Implements Digikam::DPlugin.

References Digikam::DPluginAction::actionCategoryToString().

cleanUp()

void DigikamGenericFileCopyPlugin::FCPlugin::cleanUp ( )

overridevirtual

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

Reimplemented from Digikam::DPlugin.

count()

int Digikam::DPluginGeneric::count ( ) const

overridevirtualinherited

Return the amount of tools registered to all parents.

Implements Digikam::DPlugin.

description()

QString DigikamGenericFileCopyPlugin::FCPlugin::description ( ) const

overridevirtual

Returns a short description about the plugin.

Implements Digikam::DPlugin.

details()

QString DigikamGenericFileCopyPlugin::FCPlugin::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().

findActionByName()

DPluginAction * Digikam::DPluginGeneric::findActionByName ( const QString &  name, QObject *const  parent  ) const

inherited

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

References Digikam::DPluginGeneric::actions(), and Digikam::DPlugin::name().

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::DPluginBqm, and Digikam::DPluginDImg.

icon()

QIcon DigikamGenericFileCopyPlugin::FCPlugin::icon ( ) const

overridevirtual

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

Reimplemented from Digikam::DPlugin.

Referenced by setup().

ifaceIid()

QString Digikam::DPluginGeneric::ifaceIid ( ) const

inlineoverridevirtualinherited

Return the plugin interface identifier.

Implements Digikam::DPlugin.

References DIGIKAM_DPLUGIN_GENERIC_IID.

Referenced by Digikam::DPluginGeneric::addAction().

iid()

QString DigikamGenericFileCopyPlugin::FCPlugin::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::DPluginGeneric::infoIface ( QObject *const  ac ) const

protectedinherited

Return the info interface instance for the given action object.

References Digikam::DXmlGuiWindow::infoIface().

Referenced by DigikamGenericSlideShowPlugin::SlideShowPlugin::setup().

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 DigikamGenericFileCopyPlugin::FCPlugin::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.

reactivateToolDialog()

bool Digikam::DPluginGeneric::reactivateToolDialog ( QWidget *const  dlg ) const

protectedinherited

Helper function to reactivate the desktop visibility of tool widget.

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 DigikamGenericFileCopyPlugin::FCPlugin::setup ( QObject * const  parent )

overridevirtual

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

Implements Digikam::DPlugin.

References Digikam::DPluginGeneric::addAction(), icon(), and Digikam::DPluginAction::setActionCategory().

setVisible()

void Digikam::DPluginGeneric::setVisible ( bool  b )

overridevirtualinherited

Holds whether the plugin can be seen in parent view.

Implements Digikam::DPlugin.

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

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

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:

• core/dplugins/generic/webservices/filecopy/fcplugin.h
• core/dplugins/generic/webservices/filecopy/fcplugin.cpp