digiKam
Digikam::DPluginAction Class Reference
+ Inheritance diagram for Digikam::DPluginAction:

Public Types

enum  ActionCategory {
  InvalidCat = -1 , GenericExport = 0 , GenericImport , GenericTool ,
  GenericMetadata , GenericView , EditorFile , EditorColors ,
  EditorEnhance , EditorTransform , EditorDecorate , EditorFilters
}
 Plugin action categories. More...
 
enum  ActionType { InvalidType = -1 , Generic = 0 , Editor }
 Plugin action types to resume where they can be used. More...
 

Public Member Functions

ActionCategory actionCategory () const
 
QString actionCategoryToString () const
 
ActionType actionType () const
 
 DPluginAction (QObject *const parent=nullptr)
 
QString pluginId () const
 
void setActionCategory (ActionCategory cat)
 
QString toString () const
 
QString xmlSection () const
 
 ~DPluginAction () override
 

Static Public Member Functions

static bool pluginActionLessThan (DPluginAction *const a, DPluginAction *const b)
 

Member Enumeration Documentation

◆ ActionCategory

Plugin action categories.

Enumerator
InvalidCat 
GenericExport 

Generic export action.

GenericImport 

Generic import action.

GenericTool 

Generic processing action.

GenericMetadata 

Generic Metadata adjustement action.

GenericView 

Generic View action (as Slideshow).

EditorFile 

Image Editor file action.

EditorColors 

Image Editor color correction action.

EditorEnhance 

Image Editor enhance action.

EditorTransform 

Image Editor transform action.

EditorDecorate 

Image Editor decorate action.

EditorFilters 

Image Editor special effects action.

◆ ActionType

Plugin action types to resume where they can be used.

Enumerator
InvalidType 

An invalid action category.

Generic 

Generic action available everywhere (AlbumView, Editor, and LightTable).

Editor 

Specific action for Image Editor and Showfoto.

Constructor & Destructor Documentation

◆ DPluginAction()

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

◆ ~DPluginAction()

Digikam::DPluginAction::~DPluginAction ( )
override

Member Function Documentation

◆ actionCategory()

◆ actionCategoryToString()

◆ actionType()

◆ pluginActionLessThan()

bool Digikam::DPluginAction::pluginActionLessThan ( DPluginAction *const  a,
DPluginAction *const  b 
)
static

◆ pluginId()

QString Digikam::DPluginAction::pluginId ( ) const

Return the plugin id string hosting this action.

◆ setActionCategory()

void Digikam::DPluginAction::setActionCategory ( ActionCategory  cat)

Manage the internal action category.

Referenced by DigikamEditorAdjustCurvesToolPlugin::AdjustCurvesToolPlugin::setup(), DigikamEditorAdjustLevelsToolPlugin::AdjustLevelsToolPlugin::setup(), DigikamEditorAutoCorrectionToolPlugin::AutoCorrectionToolPlugin::setup(), DigikamEditorBCGToolPlugin::BCGToolPlugin::setup(), DigikamEditorBWSepiaToolPlugin::BWSepiaToolPlugin::setup(), DigikamEditorChannelMixerToolPlugin::ChannelMixerToolPlugin::setup(), DigikamEditorColorBalanceToolPlugin::CBToolPlugin::setup(), DigikamEditorConvert16To8ToolPlugin::Convert16To8ToolPlugin::setup(), DigikamEditorConvert8To16ToolPlugin::Convert8To16ToolPlugin::setup(), DigikamEditorFilmToolPlugin::FilmToolPlugin::setup(), DigikamEditorHSLToolPlugin::HSLToolPlugin::setup(), DigikamEditorInvertToolPlugin::InvertToolPlugin::setup(), DigikamEditorProfileConversionToolPlugin::ProfileConversionToolPlugin::setup(), DigikamEditorWhiteBalanceToolPlugin::WhiteBalanceToolPlugin::setup(), DigikamEditorBorderToolPlugin::BorderToolPlugin::setup(), DigikamEditorInsertTextToolPlugin::InsertTextToolPlugin::setup(), DigikamEditorTextureToolPlugin::TextureToolPlugin::setup(), DigikamEditorAntivignettingToolPlugin::AntiVignettingToolPlugin::setup(), DigikamEditorBlurToolPlugin::BlurToolPlugin::setup(), DigikamEditorHealingCloneToolPlugin::HealingCloneToolPlugin::setup(), DigikamEditorHotPixelsToolPlugin::HotPixelsToolPlugin::setup(), DigikamEditorLensAutoFixToolPlugin::LensAutoFixToolPlugin::setup(), DigikamEditorLensDistortionToolPlugin::LensDistortionToolPlugin::setup(), DigikamEditorLocalContrastToolPlugin::LocalContrastToolPlugin::setup(), DigikamEditorNoiseReductionToolPlugin::LocalContrastToolPlugin::setup(), DigikamEditorRedEyeToolPlugin::RedEyeToolPlugin::setup(), DigikamEditorRestorationToolPlugin::RestoreToolPlugin::setup(), DigikamEditorSharpenToolPlugin::SharpenToolPlugin::setup(), DigikamEditorPrintToolPlugin::PrintToolPlugin::setup(), DigikamEditorBlurFxToolPlugin::BlurFXToolPlugin::setup(), DigikamEditorCharcoalToolPlugin::CharcoalToolPlugin::setup(), DigikamEditorColorFxToolPlugin::ColorFXToolPlugin::setup(), DigikamEditorDistortionFxToolPlugin::DistortionFXToolPlugin::setup(), DigikamEditorEmbossToolPlugin::EmbossToolPlugin::setup(), DigikamEditorFilmGrainToolPlugin::FilmGrainToolPlugin::setup(), DigikamEditorOilPaintToolPlugin::OilPaintToolPlugin::setup(), DigikamEditorRainDropToolPlugin::RainDropToolPlugin::setup(), DigikamEditorAutoCropToolPlugin::AutoCropToolPlugin::setup(), DigikamEditorContentAwareResizeToolPlugin::ContentAwareResizeToolPlugin::setup(), DigikamEditorFreeRotationToolPlugin::FreeRotationToolPlugin::setup(), DigikamEditorPerspectiveToolPlugin::PerspectiveToolPlugin::setup(), DigikamEditorRatioCropToolPlugin::RatioCropToolPlugin::setup(), DigikamEditorResizeToolPlugin::ResizeToolPlugin::setup(), DigikamEditorShearToolPlugin::ShearToolPlugin::setup(), 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(), DigikamGenericFileCopyPlugin::FCPlugin::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().

◆ toString()

QString Digikam::DPluginAction::toString ( ) const

Return details as string about action properties. For debug purpose only.

References actionCategoryToString().

◆ xmlSection()

QString Digikam::DPluginAction::xmlSection ( ) const

Return the XML section to merge in KXMLGUIClient host XML definition.

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


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