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

Public Types

enum  RenderingMode { NoneRendering = 0 , PreviewRendering , FinalRendering }
 

Public Slots

virtual void slotAbort ()
 
virtual void slotApplyTool ()
 
virtual void slotCloseTool ()
 
void slotPreviewModeChanged ()
 
void slotUpdateSpotInfo (const Digikam::DColor &col, const QPoint &point)
 

Signals

void cancelClicked ()
 
void okClicked ()
 

Public Member Functions

 EditorToolThreaded (QObject *const parent)
 
virtual void exposureSettingsChanged ()
 
virtual void ICCSettingsChanged ()
 
void init ()
 
DPluginplugin () const
 
RenderingMode renderingMode () const
 
virtual void setBackgroundColor (const QColor &bg)
 
void setInitPreview (bool b)
 
void setPlugin (DPlugin *const plugin)
 
void setProgressMessage (const QString &mess)
 
FilterAction::Category toolCategory () const
 
QString toolHelp () const
 
QIcon toolIcon () const
 
QString toolName () const
 
EditorToolSettingstoolSettings () const
 
int toolVersion () const
 
QWidget * toolView () const
 
 ~EditorToolThreaded () override
 

Protected Slots

void slotAnalyserFinished (bool success)
 
void slotAnalyserStarted ()
 
void slotCancel () override
 
void slotFilterFinished (bool success)
 
void slotFilterStarted ()
 
void slotInit () override
 
virtual void slotLoadSettings ()
 
void slotOk () override
 
void slotPreview () override
 
void slotProgress (int progress)
 
virtual void slotResetSettings ()
 
void slotTimer ()
 

Protected Member Functions

DImgThreadedAnalyseranalyser () const
 
virtual void analyserCompleted ()
 
void deleteFilterInstance (bool b=true)
 
DImgThreadedFilterfilter () const
 
virtual void finalRendering ()
 
virtual void prepareFinal ()
 
virtual void preparePreview ()
 
virtual void readSettings ()
 
virtual void renderingFinished ()
 
void setAnalyser (DImgThreadedAnalyser *const analyser)
 
virtual void setBusy (bool)
 
void setFilter (DImgThreadedFilter *const filter)
 
virtual void setFinalImage ()
 
virtual void setPreviewImage ()
 
void setPreviewModeMask (int mask)
 
void setToolCategory (const FilterAction::Category category)
 
void setToolHelp (const QString &anchor)
 
void setToolIcon (const QIcon &icon)
 
void setToolInfoMessage (const QString &txt)
 
void setToolName (const QString &name)
 
virtual void setToolSettings (EditorToolSettings *const settings)
 
void setToolVersion (const int version)
 
virtual void setToolView (QWidget *const view)
 
virtual void slotChannelChanged ()
 
virtual void slotSaveAsSettings ()
 
virtual void slotScaleChanged ()
 
virtual void writeSettings ()
 

Member Enumeration Documentation

◆ RenderingMode

Enumerator
NoneRendering 
PreviewRendering 
FinalRendering 

Constructor & Destructor Documentation

◆ EditorToolThreaded()

Digikam::EditorToolThreaded::EditorToolThreaded ( QObject *const  parent)
explicit

◆ ~EditorToolThreaded()

Digikam::EditorToolThreaded::~EditorToolThreaded ( )
override

Member Function Documentation

◆ analyser()

DImgThreadedAnalyser * Digikam::EditorToolThreaded::analyser ( ) const
protected

Manage analyser instance plugged in tool interface

Referenced by setAnalyser(), and slotAbort().

◆ analyserCompleted()

virtual void Digikam::EditorToolThreaded::analyserCompleted ( )
inlineprotectedvirtual

Referenced by slotAnalyserFinished().

◆ cancelClicked

void Digikam::EditorTool::cancelClicked ( )
signalinherited

◆ deleteFilterInstance()

void Digikam::EditorToolThreaded::deleteFilterInstance ( bool  b = true)
protected

If true, delete filter instance when preview or final rendering is processed. If false, filter instance will be managed outside for ex. with ContentAwareResizing tool.

◆ exposureSettingsChanged()

void Digikam::EditorTool::exposureSettingsChanged ( )
virtualinherited

◆ filter()

DImgThreadedFilter * Digikam::EditorToolThreaded::filter ( ) const
protected

Manage filter instance plugged in tool interface

Referenced by DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::fastConversion(), setFilter(), and slotAbort().

◆ finalRendering()

virtual void Digikam::EditorTool::finalRendering ( )
inlineprotectedvirtualinherited

◆ ICCSettingsChanged()

void Digikam::EditorTool::ICCSettingsChanged ( )
virtualinherited

◆ init()

void Digikam::EditorTool::init ( )
inherited

Called by editor tool interface to initialized tool when all is ready, through slotInit().

References Digikam::EditorTool::slotInit().

◆ okClicked

void Digikam::EditorTool::okClicked ( )
signalinherited

◆ plugin()

DPlugin * Digikam::EditorTool::plugin ( ) const
inherited

◆ prepareFinal()

virtual void Digikam::EditorToolThreaded::prepareFinal ( )
inlineprotectedvirtual

Referenced by slotOk().

◆ preparePreview()

virtual void Digikam::EditorToolThreaded::preparePreview ( )
inlineprotectedvirtual

Referenced by slotPreview().

◆ readSettings()

void Digikam::EditorTool::readSettings ( )
protectedvirtualinherited

◆ renderingFinished()

virtual void Digikam::EditorToolThreaded::renderingFinished ( )
inlineprotectedvirtual

Referenced by slotAbort().

◆ renderingMode()

EditorToolThreaded::RenderingMode Digikam::EditorToolThreaded::renderingMode ( ) const

return the current tool rendering mode.

◆ setAnalyser()

◆ setBackgroundColor()

void Digikam::EditorTool::setBackgroundColor ( const QColor &  bg)
virtualinherited

◆ setBusy()

void Digikam::EditorTool::setBusy ( bool  state)
protectedvirtualinherited

◆ setFilter()

void Digikam::EditorToolThreaded::setFilter ( DImgThreadedFilter *const  filter)
protected

◆ setFinalImage()

virtual void Digikam::EditorToolThreaded::setFinalImage ( )
inlineprotectedvirtual

Referenced by slotFilterFinished().

◆ setInitPreview()

◆ setPlugin()

◆ setPreviewImage()

virtual void Digikam::EditorToolThreaded::setPreviewImage ( )
inlineprotectedvirtual

Referenced by slotFilterFinished().

◆ setPreviewModeMask()

void Digikam::EditorTool::setPreviewModeMask ( int  mask)
protectedinherited

References Digikam::EditorToolIface::editorToolIface(), and Digikam::EditorToolIface::setPreviewModeMask().

Referenced by DigikamEditorAdjustCurvesToolPlugin::AdjustCurvesTool::AdjustCurvesTool(), DigikamEditorAdjustLevelsToolPlugin::AdjustLevelsTool::AdjustLevelsTool(), DigikamEditorAntivignettingToolPlugin::AntiVignettingTool::AntiVignettingTool(), DigikamEditorAutoCorrectionToolPlugin::AutoCorrectionTool::AutoCorrectionTool(), DigikamEditorBCGToolPlugin::BCGTool::BCGTool(), DigikamEditorBlurFxToolPlugin::BlurFXTool::BlurFXTool(), DigikamEditorBlurToolPlugin::BlurTool::BlurTool(), DigikamEditorBorderToolPlugin::BorderTool::BorderTool(), DigikamEditorBWSepiaToolPlugin::BWSepiaTool::BWSepiaTool(), DigikamEditorColorBalanceToolPlugin::CBTool::CBTool(), DigikamEditorChannelMixerToolPlugin::ChannelMixerTool::ChannelMixerTool(), DigikamEditorCharcoalToolPlugin::CharcoalTool::CharcoalTool(), DigikamEditorColorFxToolPlugin::ColorFxTool::ColorFxTool(), DigikamEditorContentAwareResizeToolPlugin::ContentAwareResizeTool::ContentAwareResizeTool(), DigikamEditorDistortionFxToolPlugin::DistortionFXTool::DistortionFXTool(), DigikamEditorEmbossToolPlugin::EmbossTool::EmbossTool(), DigikamEditorFilmGrainToolPlugin::FilmGrainTool::FilmGrainTool(), DigikamEditorFilmToolPlugin::FilmTool::FilmTool(), DigikamEditorFreeRotationToolPlugin::FreeRotationTool::FreeRotationTool(), DigikamEditorHealingCloneToolPlugin::HealingCloneTool::HealingCloneTool(), DigikamEditorHotPixelsToolPlugin::HotPixelsTool::HotPixelsTool(), DigikamEditorHSLToolPlugin::HSLTool::HSLTool(), DigikamEditorLensAutoFixToolPlugin::LensAutoFixTool::LensAutoFixTool(), DigikamEditorLocalContrastToolPlugin::LocalContrastTool::LocalContrastTool(), DigikamEditorNoiseReductionToolPlugin::NoiseReductionTool::NoiseReductionTool(), DigikamEditorOilPaintToolPlugin::OilPaintTool::OilPaintTool(), DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::ProfileConversionTool(), DigikamEditorRainDropToolPlugin::RainDropTool::RainDropTool(), DigikamEditorRedEyeToolPlugin::RedEyeTool::RedEyeTool(), DigikamEditorResizeToolPlugin::ResizeTool::ResizeTool(), DigikamEditorRestorationToolPlugin::RestorationTool::RestorationTool(), DigikamEditorSharpenToolPlugin::SharpenTool::SharpenTool(), DigikamEditorShearToolPlugin::ShearTool::ShearTool(), DigikamEditorTextureToolPlugin::TextureTool::TextureTool(), and DigikamEditorWhiteBalanceToolPlugin::WhiteBalanceTool::WhiteBalanceTool().

◆ setProgressMessage()

void Digikam::EditorToolThreaded::setProgressMessage ( const QString &  mess)

Set the small text to show in editor status progress bar during tool computation. If it's not set, tool name is used instead.

Referenced by DigikamRawImportNativePlugin::RawImport::RawImport().

◆ setToolCategory()

void Digikam::EditorTool::setToolCategory ( const FilterAction::Category  category)
protectedinherited

◆ setToolHelp()

◆ setToolIcon()

◆ setToolInfoMessage()

void Digikam::EditorTool::setToolInfoMessage ( const QString &  txt)
protectedinherited

◆ setToolName()

◆ setToolSettings()

void Digikam::EditorTool::setToolSettings ( EditorToolSettings *const  settings)
protectedvirtualinherited

References Digikam::EditorTool::slotCancel(), Digikam::EditorTool::slotChannelChanged(), Digikam::EditorTool::slotLoadSettings(), Digikam::EditorTool::slotOk(), Digikam::EditorTool::slotPreview(), Digikam::EditorTool::slotResetSettings(), Digikam::EditorTool::slotSaveAsSettings(), and Digikam::EditorTool::slotScaleChanged().

Referenced by DigikamEditorAdjustCurvesToolPlugin::AdjustCurvesTool::AdjustCurvesTool(), DigikamEditorAdjustLevelsToolPlugin::AdjustLevelsTool::AdjustLevelsTool(), DigikamEditorAntivignettingToolPlugin::AntiVignettingTool::AntiVignettingTool(), DigikamEditorAutoCorrectionToolPlugin::AutoCorrectionTool::AutoCorrectionTool(), DigikamEditorBCGToolPlugin::BCGTool::BCGTool(), DigikamEditorBlurFxToolPlugin::BlurFXTool::BlurFXTool(), DigikamEditorBlurToolPlugin::BlurTool::BlurTool(), DigikamEditorBorderToolPlugin::BorderTool::BorderTool(), DigikamEditorBWSepiaToolPlugin::BWSepiaTool::BWSepiaTool(), DigikamEditorColorBalanceToolPlugin::CBTool::CBTool(), DigikamEditorChannelMixerToolPlugin::ChannelMixerTool::ChannelMixerTool(), DigikamEditorCharcoalToolPlugin::CharcoalTool::CharcoalTool(), DigikamEditorColorFxToolPlugin::ColorFxTool::ColorFxTool(), DigikamEditorContentAwareResizeToolPlugin::ContentAwareResizeTool::ContentAwareResizeTool(), DigikamEditorDistortionFxToolPlugin::DistortionFXTool::DistortionFXTool(), DigikamEditorEmbossToolPlugin::EmbossTool::EmbossTool(), DigikamEditorFilmGrainToolPlugin::FilmGrainTool::FilmGrainTool(), DigikamEditorFilmToolPlugin::FilmTool::FilmTool(), DigikamEditorFreeRotationToolPlugin::FreeRotationTool::FreeRotationTool(), DigikamEditorHealingCloneToolPlugin::HealingCloneTool::HealingCloneTool(), DigikamEditorHotPixelsToolPlugin::HotPixelsTool::HotPixelsTool(), DigikamEditorHSLToolPlugin::HSLTool::HSLTool(), DigikamEditorInsertTextToolPlugin::InsertTextTool::InsertTextTool(), DigikamEditorLensAutoFixToolPlugin::LensAutoFixTool::LensAutoFixTool(), DigikamEditorLensDistortionToolPlugin::LensDistortionTool::LensDistortionTool(), DigikamEditorLocalContrastToolPlugin::LocalContrastTool::LocalContrastTool(), DigikamEditorNoiseReductionToolPlugin::NoiseReductionTool::NoiseReductionTool(), DigikamEditorOilPaintToolPlugin::OilPaintTool::OilPaintTool(), DigikamEditorPerspectiveToolPlugin::PerspectiveTool::PerspectiveTool(), DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::ProfileConversionTool(), DigikamEditorRainDropToolPlugin::RainDropTool::RainDropTool(), DigikamEditorRatioCropToolPlugin::RatioCropTool::RatioCropTool(), DigikamRawImportNativePlugin::RawImport::RawImport(), DigikamEditorRedEyeToolPlugin::RedEyeTool::RedEyeTool(), DigikamEditorResizeToolPlugin::ResizeTool::ResizeTool(), DigikamEditorRestorationToolPlugin::RestorationTool::RestorationTool(), DigikamEditorSharpenToolPlugin::SharpenTool::SharpenTool(), DigikamEditorShearToolPlugin::ShearTool::ShearTool(), DigikamEditorTextureToolPlugin::TextureTool::TextureTool(), and DigikamEditorWhiteBalanceToolPlugin::WhiteBalanceTool::WhiteBalanceTool().

◆ setToolVersion()

void Digikam::EditorTool::setToolVersion ( const int  version)
protectedinherited

◆ setToolView()

void Digikam::EditorTool::setToolView ( QWidget *const  view)
protectedvirtualinherited

References Digikam::EditorTool::slotUpdateSpotInfo().

Referenced by DigikamEditorAdjustCurvesToolPlugin::AdjustCurvesTool::AdjustCurvesTool(), DigikamEditorAdjustLevelsToolPlugin::AdjustLevelsTool::AdjustLevelsTool(), DigikamEditorAntivignettingToolPlugin::AntiVignettingTool::AntiVignettingTool(), DigikamEditorAutoCorrectionToolPlugin::AutoCorrectionTool::AutoCorrectionTool(), DigikamEditorBCGToolPlugin::BCGTool::BCGTool(), DigikamEditorBlurFxToolPlugin::BlurFXTool::BlurFXTool(), DigikamEditorBlurToolPlugin::BlurTool::BlurTool(), DigikamEditorBorderToolPlugin::BorderTool::BorderTool(), DigikamEditorBWSepiaToolPlugin::BWSepiaTool::BWSepiaTool(), DigikamEditorColorBalanceToolPlugin::CBTool::CBTool(), DigikamEditorChannelMixerToolPlugin::ChannelMixerTool::ChannelMixerTool(), DigikamEditorCharcoalToolPlugin::CharcoalTool::CharcoalTool(), DigikamEditorColorFxToolPlugin::ColorFxTool::ColorFxTool(), DigikamEditorContentAwareResizeToolPlugin::ContentAwareResizeTool::ContentAwareResizeTool(), DigikamEditorDistortionFxToolPlugin::DistortionFXTool::DistortionFXTool(), DigikamEditorEmbossToolPlugin::EmbossTool::EmbossTool(), DigikamEditorFilmGrainToolPlugin::FilmGrainTool::FilmGrainTool(), DigikamEditorFilmToolPlugin::FilmTool::FilmTool(), DigikamEditorFreeRotationToolPlugin::FreeRotationTool::FreeRotationTool(), DigikamEditorHealingCloneToolPlugin::HealingCloneTool::HealingCloneTool(), DigikamEditorHotPixelsToolPlugin::HotPixelsTool::HotPixelsTool(), DigikamEditorHSLToolPlugin::HSLTool::HSLTool(), DigikamEditorInsertTextToolPlugin::InsertTextTool::InsertTextTool(), DigikamEditorLensAutoFixToolPlugin::LensAutoFixTool::LensAutoFixTool(), DigikamEditorLensDistortionToolPlugin::LensDistortionTool::LensDistortionTool(), DigikamEditorLocalContrastToolPlugin::LocalContrastTool::LocalContrastTool(), DigikamEditorNoiseReductionToolPlugin::NoiseReductionTool::NoiseReductionTool(), DigikamEditorOilPaintToolPlugin::OilPaintTool::OilPaintTool(), DigikamEditorPerspectiveToolPlugin::PerspectiveTool::PerspectiveTool(), DigikamEditorProfileConversionToolPlugin::ProfileConversionTool::ProfileConversionTool(), DigikamEditorRainDropToolPlugin::RainDropTool::RainDropTool(), DigikamEditorRatioCropToolPlugin::RatioCropTool::RatioCropTool(), DigikamRawImportNativePlugin::RawImport::RawImport(), DigikamEditorRedEyeToolPlugin::RedEyeTool::RedEyeTool(), DigikamEditorResizeToolPlugin::ResizeTool::ResizeTool(), DigikamEditorRestorationToolPlugin::RestorationTool::RestorationTool(), DigikamEditorSharpenToolPlugin::SharpenTool::SharpenTool(), DigikamEditorShearToolPlugin::ShearTool::ShearTool(), DigikamEditorTextureToolPlugin::TextureTool::TextureTool(), and DigikamEditorWhiteBalanceToolPlugin::WhiteBalanceTool::WhiteBalanceTool().

◆ slotAbort

◆ slotAnalyserFinished

void Digikam::EditorToolThreaded::slotAnalyserFinished ( bool  success)
protectedslot

◆ slotAnalyserStarted

void Digikam::EditorToolThreaded::slotAnalyserStarted ( )
protectedslot

Manage start and end events from analyser

Referenced by setAnalyser().

◆ slotApplyTool

void Digikam::EditorTool::slotApplyTool ( )
virtualslotinherited

◆ slotCancel

void Digikam::EditorToolThreaded::slotCancel ( )
overrideprotectedslot

◆ slotChannelChanged()

virtual void Digikam::EditorTool::slotChannelChanged ( )
inlineprotectedvirtualinherited

◆ slotCloseTool

void Digikam::EditorTool::slotCloseTool ( )
virtualslotinherited

◆ slotFilterFinished

◆ slotFilterStarted

void Digikam::EditorToolThreaded::slotFilterStarted ( )
protectedslot

Manage start and end events from filter

Referenced by setFilter().

◆ slotInit

void Digikam::EditorToolThreaded::slotInit ( )
overrideprotectedslot

◆ slotLoadSettings

virtual void Digikam::EditorTool::slotLoadSettings ( )
inlineprotectedvirtualslotinherited

◆ slotOk

◆ slotPreview

◆ slotPreviewModeChanged

void Digikam::EditorTool::slotPreviewModeChanged ( )
slotinherited

◆ slotProgress

void Digikam::EditorToolThreaded::slotProgress ( int  progress)
protectedslot

Dispatch progress event from filter and analyser

References Digikam::EditorToolIface::editorToolIface(), and Digikam::EditorToolIface::setToolProgress().

Referenced by setAnalyser(), and setFilter().

◆ slotResetSettings

void Digikam::EditorTool::slotResetSettings ( )
protectedvirtualslotinherited

◆ slotSaveAsSettings()

virtual void Digikam::EditorTool::slotSaveAsSettings ( )
inlineprotectedvirtualinherited

◆ slotScaleChanged()

virtual void Digikam::EditorTool::slotScaleChanged ( )
inlineprotectedvirtualinherited

◆ slotTimer

◆ slotUpdateSpotInfo

void Digikam::EditorTool::slotUpdateSpotInfo ( const Digikam::DColor col,
const QPoint &  point 
)
slotinherited

◆ toolCategory()

FilterAction::Category Digikam::EditorTool::toolCategory ( ) const
inherited

◆ toolHelp()

QString Digikam::EditorTool::toolHelp ( ) const
inherited

◆ toolIcon()

QIcon Digikam::EditorTool::toolIcon ( ) const
inherited

◆ toolName()

QString Digikam::EditorTool::toolName ( ) const
inherited

◆ toolSettings()

EditorToolSettings * Digikam::EditorTool::toolSettings ( ) const
inherited

◆ toolVersion()

int Digikam::EditorTool::toolVersion ( ) const
inherited

◆ toolView()

QWidget * Digikam::EditorTool::toolView ( ) const
inherited

◆ writeSettings()

void Digikam::EditorTool::writeSettings ( )
protectedvirtualinherited

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