digiKam
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
Digikam::BatchTool Class Referenceabstract
+ Inheritance diagram for Digikam::BatchTool:

Public Types

enum  BatchToolGroup {
  BaseTool = 0 , CustomTool , ColorTool , EnhanceTool ,
  TransformTool , DecorateTool , FiltersTool , ConvertTool ,
  MetadataTool
}
 

Public Slots

void slotResetSettingsToDefault ()
 
void slotSettingsChanged (const BatchToolSettings &settings)
 

Signals

void signalAssignSettings2Widget ()
 
void signalSettingsChanged (const BatchToolSettings &)
 
void signalVisible (bool)
 

Public Member Functions

bool apply ()
 
 BatchTool (const QString &name, BatchToolGroup group, QObject *const parent=nullptr)
 Tool data and properties management. NOTE: these methods can be used safely in multi-threading part (ActionThread). More...
 
virtual void cancel ()
 
virtual BatchTool * clone (QObject *const parent=nullptr) const =0
 
virtual BatchToolSettings defaultSettings ()=0
 
void deleteSettingsWidget ()
 
QString errorDescription () const
 
bool getBranchHistory () const
 
bool getNeedResetExifOrientation () const
 
bool getResetExifOrientationAllowed () const
 
DImg imageData () const
 
ItemInfo imageInfo () const
 
QUrl inputUrl () const
 
IOFileSettings ioFileSettings () const
 
bool isLastChainedTool () const
 
bool loadToDImg () const
 
virtual QString outputSuffix () const
 
QUrl outputUrl () const
 
DPluginBqm * plugin () const
 
DRawDecoderSettings rawDecodingSettings () const
 
virtual void registerSettingsWidget ()
 
bool savefromDImg () const
 
void setBranchHistory (bool branch=true)
 
void setDRawDecoderSettings (const DRawDecoderSettings &settings)
 
void setImageData (const DImg &img)
 
void setInputUrl (const QUrl &inputUrl)
 
void setIOFileSettings (const IOFileSettings &settings)
 
void setItemInfo (const ItemInfo &info)
 
void setLastChainedTool (bool last)
 
void setNeedResetExifOrientation (bool reset)
 
void setOutputUrl (const QUrl &outputUrl)
 
void setOutputUrlFromInputUrl ()
 
void setPlugin (DPluginBqm *const plugin)
 
void setRawLoadingRules (QueueSettings::RawLoadingRule rule)
 
void setResetExifOrientationAllowed (bool reset)
 
void setSaveAsNewVersion (bool fork=true)
 
void setSettings (const BatchToolSettings &settings)
 
BatchToolSettings settings () const
 
QWidget * settingsWidget () const
 Settings widget management. NOTE: do not use these methods in multi-threading part (ActionThread), only in main thread (GUI) More...
 
void setToolDescription (const QString &toolDescription)
 
void setToolIcon (const QIcon &icon)
 
void setToolIconName (const QString &iconName)
 
void setToolTitle (const QString &toolTitle)
 
void setWorkingUrl (const QUrl &workingUrl)
 
QString toolDescription () const
 
BatchToolGroup toolGroup () const
 
QString toolGroupToString () const
 
QIcon toolIcon () const
 
QString toolTitle () const
 
virtual int toolVersion () const
 
QUrl workingUrl () const
 
 ~BatchTool () override
 

Protected Slots

virtual void slotAssignSettings2Widget ()=0
 
virtual void slotSettingsChanged ()=0
 

Protected Member Functions

void applyFilter (DImgBuiltinFilter *const filter)
 
void applyFilter (DImgThreadedFilter *const filter)
 
void applyFilterChangedProperties (DImgThreadedFilter *const filter)
 
DImg & image () const
 
bool isCancelled () const
 
bool isRawFile (const QUrl &url) const
 
void setErrorDescription (const QString &errmsg)
 
virtual bool toolOperations ()=0
 

Protected Attributes

QWidget * m_settingsWidget
 

Member Enumeration Documentation

◆ BatchToolGroup

enum Digikam::BatchTool::BatchToolGroup
Enumerator
BaseTool 

digiKam core tools.

CustomTool 

List of tools grouped and customized by users.

ColorTool 

Tools to manage image colors (Curves, BCG, etc...)

EnhanceTool 

Tools to enhance images (NR, sharp, etc...)

TransformTool 

Tools to transform images geometry (resize, rotate, flip, etc...)

DecorateTool 

Tools to decorate images (Border, watermark, etc...)

FiltersTool 

Tools to apply filters and special effects (film grain, BlurFx, etc...)

ConvertTool 

Tools to convert images format (PNG, JPEG, TIFF, etc...)

MetadataTool 

Tools to play with metadata.

Constructor & Destructor Documentation

◆ BatchTool()

Digikam::BatchTool::BatchTool ( const QString &  name,
BatchToolGroup  group,
QObject *const  parent = nullptr 
)
explicit

Tool data and properties management. NOTE: these methods can be used safely in multi-threading part (ActionThread).

References m_settingsWidget.

◆ ~BatchTool()

Digikam::BatchTool::~BatchTool ( )
override

Member Function Documentation

◆ apply()

bool Digikam::BatchTool::apply ( )

Apply all change to perform by this tool. This method call customized toolOperations().

References inputUrl(), outputUrl(), settings(), toolOperations(), and toolTitle().

◆ applyFilter() [1/2]

void Digikam::BatchTool::applyFilter ( DImgBuiltinFilter *const  filter)
protected

References Digikam::DImgBuiltinFilter::apply(), and Digikam::DImgBuiltinFilter::filterAction().

◆ applyFilter() [2/2]

void Digikam::BatchTool::applyFilter ( DImgThreadedFilter *const  filter)
protected

Use this if you have a filter ready to run. Will call startFilterDirectly and apply the result to image().

References Digikam::DImg::bits(), Digikam::DImgThreadedFilter::filterAction(), Digikam::DImgThreadedFilter::getTargetImage(), isCancelled(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ applyFilterChangedProperties()

void Digikam::BatchTool::applyFilterChangedProperties ( DImgThreadedFilter *const  filter)
protected

References Digikam::DImg::bits(), Digikam::DImgThreadedFilter::filterAction(), Digikam::DImgThreadedFilter::getTargetImage(), Digikam::DImg::hasAlpha(), Digikam::DImg::height, isCancelled(), Digikam::DImg::sixteenBit, Digikam::DImgThreadedFilter::startFilterDirectly(), and Digikam::DImg::width.

◆ cancel()

void Digikam::BatchTool::cancel ( )
virtual

Re-implement this method is you want customize cancellation of tool, for ex. to call a dedicated method to kill sub-threads parented to this tool instance. Unforget to call parent BatchTool::cancel() method in your customized implementation.

Reimplemented in Digikam::Restoration, DigikamBqmRestorationPlugin::RedEyeCorrection, and DigikamBqmConvertToDngPlugin::ConvertToDNG.

Referenced by Digikam::Restoration::cancel().

◆ clone()

virtual BatchTool* Digikam::BatchTool::clone ( QObject *const  parent = nullptr) const
pure virtual

Clone this tool without to create settings widget. It's a safe construction of tools instance used in multithreading (ActionThread) to process items in parallel.

Implemented in DigikamBqmRotatePlugin::Rotate, DigikamBqmResizePlugin::Resize, DigikamBqmFlipPlugin::Flip, DigikamBqmCropPlugin::Crop, DigikamBqmTimeAdjustPlugin::TimeAdjust, DigikamBqmRemoveMetadataPlugin::RemoveMetadata, DigikamBqmAssignTemplatePlugin::AssignTemplate, DigikamBqmFilmGrainPlugin::FilmGrain, DigikamBqmColorFXPlugin::ColorFX, DigikamBqmSharpenPlugin::Sharpen, Digikam::Restoration, DigikamBqmRestorationPlugin::RedEyeCorrection, DigikamBqmNoiseReductionPlugin::NoiseReduction, DigikamBqmLocalContrastPlugin::LocalContrast, DigikamBqmLensAutoFixPlugin::LensAutoFix, DigikamBqmHotPixelsPlugin::HotPixels, DigikamBqmBlurPlugin::Blur, DigikamBqmAntiVignettingPlugin::AntiVignetting, DigikamBqmWatermarkPlugin::WaterMark, DigikamBqmTexturePlugin::Texture, DigikamBqmBorderPlugin::Border, DigikamBqmUserScriptPlugin::UserScript, DigikamBqmConvertToTiffPlugin::ConvertToTIFF, DigikamBqmConvertToPngPlugin::ConvertToPNG, DigikamBqmConvertToPgfPlugin::ConvertToPGF, DigikamBqmConvertToJpegPlugin::ConvertToJPEG, DigikamBqmConvertToJp2Plugin::ConvertToJP2, DigikamBqmConvertToHeifPlugin::ConvertToHEIF, DigikamBqmConvertToDngPlugin::ConvertToDNG, DigikamBqmWhiteBalancePlugin::WhiteBalance, DigikamBqmInvertPlugin::Invert, DigikamBqmIccConvertPlugin::IccConvert, DigikamBqmHSLCorrectionPlugin::HSLCorrection, DigikamBqmCurvesAdjustPlugin::CurvesAdjust, DigikamBqmConvert8To16Plugin::Convert8to16, DigikamBqmConvert16To8Plugin::Convert16to8, DigikamBqmColorBalancePlugin::ColorBalance, DigikamBqmChannelMixerPlugin::ChannelMixer, DigikamBqmBWConvertPlugin::BWConvert, DigikamBqmBCGCorrectionPlugin::BCGCorrection, and DigikamBqmAutoCorrectionPlugin::AutoCorrection.

Referenced by Digikam::Task::run().

◆ defaultSettings()

virtual BatchToolSettings Digikam::BatchTool::defaultSettings ( )
pure virtual

Re-implement this method to initialize Settings Widget value with default settings.

Implemented in DigikamBqmRotatePlugin::Rotate, DigikamBqmResizePlugin::Resize, DigikamBqmFlipPlugin::Flip, DigikamBqmCropPlugin::Crop, DigikamBqmTimeAdjustPlugin::TimeAdjust, DigikamBqmRemoveMetadataPlugin::RemoveMetadata, DigikamBqmAssignTemplatePlugin::AssignTemplate, DigikamBqmFilmGrainPlugin::FilmGrain, DigikamBqmColorFXPlugin::ColorFX, DigikamBqmSharpenPlugin::Sharpen, Digikam::Restoration, DigikamBqmRestorationPlugin::RedEyeCorrection, DigikamBqmNoiseReductionPlugin::NoiseReduction, DigikamBqmLocalContrastPlugin::LocalContrast, DigikamBqmLensAutoFixPlugin::LensAutoFix, DigikamBqmHotPixelsPlugin::HotPixels, DigikamBqmBlurPlugin::Blur, DigikamBqmAntiVignettingPlugin::AntiVignetting, DigikamBqmWatermarkPlugin::WaterMark, DigikamBqmTexturePlugin::Texture, DigikamBqmBorderPlugin::Border, DigikamBqmUserScriptPlugin::UserScript, DigikamBqmConvertToTiffPlugin::ConvertToTIFF, DigikamBqmConvertToPngPlugin::ConvertToPNG, DigikamBqmConvertToPgfPlugin::ConvertToPGF, DigikamBqmConvertToJpegPlugin::ConvertToJPEG, DigikamBqmConvertToJp2Plugin::ConvertToJP2, DigikamBqmConvertToHeifPlugin::ConvertToHEIF, DigikamBqmConvertToDngPlugin::ConvertToDNG, DigikamBqmWhiteBalancePlugin::WhiteBalance, DigikamBqmInvertPlugin::Invert, DigikamBqmIccConvertPlugin::IccConvert, DigikamBqmHSLCorrectionPlugin::HSLCorrection, DigikamBqmCurvesAdjustPlugin::CurvesAdjust, DigikamBqmConvert8To16Plugin::Convert8to16, DigikamBqmConvert16To8Plugin::Convert16to8, DigikamBqmColorBalancePlugin::ColorBalance, DigikamBqmChannelMixerPlugin::ChannelMixer, DigikamBqmBWConvertPlugin::BWConvert, DigikamBqmBCGCorrectionPlugin::BCGCorrection, and DigikamBqmAutoCorrectionPlugin::AutoCorrection.

Referenced by slotResetSettingsToDefault().

◆ deleteSettingsWidget()

void Digikam::BatchTool::deleteSettingsWidget ( )

Delete dedicated settings widget registered with registerSettingsWidget().

References m_settingsWidget.

Referenced by Digikam::ToolSettingsView::~ToolSettingsView().

◆ errorDescription()

QString Digikam::BatchTool::errorDescription ( ) const

Get description of an error which appear during apply() method.

◆ getBranchHistory()

bool Digikam::BatchTool::getBranchHistory ( ) const

◆ getNeedResetExifOrientation()

bool Digikam::BatchTool::getNeedResetExifOrientation ( ) const

Returns true if the Exif orientation tag should be reset after tool operation

Referenced by savefromDImg().

◆ getResetExifOrientationAllowed()

bool Digikam::BatchTool::getResetExifOrientationAllowed ( ) const

Returns true if the Exif orientation tag is allowed to be reset after tool operation

Referenced by savefromDImg().

◆ image()

DImg & Digikam::BatchTool::image ( ) const
protected

Return a reference of internal DImg container used to modify image data.

◆ imageData()

DImg Digikam::BatchTool::imageData ( ) const

◆ imageInfo()

ItemInfo Digikam::BatchTool::imageInfo ( ) const

◆ inputUrl()

QUrl Digikam::BatchTool::inputUrl ( ) const

Referenced by apply(), loadToDImg(), setInputUrl(), and setOutputUrlFromInputUrl().

◆ ioFileSettings()

IOFileSettings Digikam::BatchTool::ioFileSettings ( ) const

Return IOFile settings used during tool operations.

Referenced by savefromDImg().

◆ isCancelled()

bool Digikam::BatchTool::isCancelled ( ) const
protected

Return true if cancel() have been called. Use this method to stop loop in your toolOperations() implementation.

Referenced by applyFilter(), and applyFilterChangedProperties().

◆ isLastChainedTool()

bool Digikam::BatchTool::isLastChainedTool ( ) const

Referenced by savefromDImg().

◆ isRawFile()

bool Digikam::BatchTool::isRawFile ( const QUrl &  url) const
protected

Method to check if file pointed by url is a RAW image

References Digikam::DRawDecoder::rawFiles().

Referenced by loadToDImg().

◆ loadToDImg()

bool Digikam::BatchTool::loadToDImg ( ) const

Load image data using input Url set by setInputUrl() to instance of internal DImg container.

References inputUrl(), isRawFile(), Digikam::DRawDecoder::loadRawPreview(), rawDecodingSettings(), and Digikam::QueueSettings::USEEMBEDEDJPEG.

◆ outputSuffix()

QString Digikam::BatchTool::outputSuffix ( ) const
virtual

Re-implement this method if tool change file extension during batch process (ex: "png"). Typically, this is used with tool which convert to new file format. This method return and empty string by default.

Reimplemented in DigikamBqmUserScriptPlugin::UserScript, DigikamBqmConvertToTiffPlugin::ConvertToTIFF, DigikamBqmConvertToPngPlugin::ConvertToPNG, DigikamBqmConvertToPgfPlugin::ConvertToPGF, DigikamBqmConvertToJpegPlugin::ConvertToJPEG, DigikamBqmConvertToJp2Plugin::ConvertToJP2, DigikamBqmConvertToHeifPlugin::ConvertToHEIF, and DigikamBqmConvertToDngPlugin::ConvertToDNG.

Referenced by savefromDImg(), setOutputUrlFromInputUrl(), and Digikam::AssignedBatchTools::targetSuffix().

◆ outputUrl()

QUrl Digikam::BatchTool::outputUrl ( ) const

Referenced by apply(), savefromDImg(), and setOutputUrl().

◆ plugin()

DPluginBqm * Digikam::BatchTool::plugin ( ) const

Referenced by Digikam::ToolsListView::addTool(), and setPlugin().

◆ rawDecodingSettings()

DRawDecoderSettings Digikam::BatchTool::rawDecodingSettings ( ) const

Return RAW decoding settings used during tool operations.

Referenced by loadToDImg().

◆ registerSettingsWidget()

void Digikam::BatchTool::registerSettingsWidget ( )
virtual

Setup dedicated settings widget. Default implementation assign no settings view (a message label is just displayed). You need to call default implementation in your child class to init default signals and slots connections, after to have instanced your dedicated settings widget.

Reimplemented in DigikamBqmRotatePlugin::Rotate, DigikamBqmResizePlugin::Resize, DigikamBqmFlipPlugin::Flip, DigikamBqmCropPlugin::Crop, DigikamBqmTimeAdjustPlugin::TimeAdjust, DigikamBqmRemoveMetadataPlugin::RemoveMetadata, DigikamBqmAssignTemplatePlugin::AssignTemplate, DigikamBqmFilmGrainPlugin::FilmGrain, DigikamBqmColorFXPlugin::ColorFX, DigikamBqmSharpenPlugin::Sharpen, Digikam::Restoration, DigikamBqmRestorationPlugin::RedEyeCorrection, DigikamBqmNoiseReductionPlugin::NoiseReduction, DigikamBqmLocalContrastPlugin::LocalContrast, DigikamBqmLensAutoFixPlugin::LensAutoFix, DigikamBqmHotPixelsPlugin::HotPixels, DigikamBqmBlurPlugin::Blur, DigikamBqmAntiVignettingPlugin::AntiVignetting, DigikamBqmWatermarkPlugin::WaterMark, DigikamBqmTexturePlugin::Texture, DigikamBqmBorderPlugin::Border, DigikamBqmUserScriptPlugin::UserScript, DigikamBqmConvertToTiffPlugin::ConvertToTIFF, DigikamBqmConvertToPngPlugin::ConvertToPNG, DigikamBqmConvertToPgfPlugin::ConvertToPGF, DigikamBqmConvertToJpegPlugin::ConvertToJPEG, DigikamBqmConvertToJp2Plugin::ConvertToJP2, DigikamBqmConvertToHeifPlugin::ConvertToHEIF, DigikamBqmConvertToDngPlugin::ConvertToDNG, DigikamBqmWhiteBalancePlugin::WhiteBalance, DigikamBqmIccConvertPlugin::IccConvert, DigikamBqmHSLCorrectionPlugin::HSLCorrection, DigikamBqmCurvesAdjustPlugin::CurvesAdjust, DigikamBqmColorBalancePlugin::ColorBalance, DigikamBqmChannelMixerPlugin::ChannelMixer, DigikamBqmBWConvertPlugin::BWConvert, DigikamBqmBCGCorrectionPlugin::BCGCorrection, and DigikamBqmAutoCorrectionPlugin::AutoCorrection.

References m_settingsWidget, signalAssignSettings2Widget(), and slotAssignSettings2Widget().

Referenced by Digikam::AssignedListView::insertTool(), and Digikam::Restoration::registerSettingsWidget().

◆ savefromDImg()

bool Digikam::BatchTool::savefromDImg ( ) const

Save image data from instance of internal DImg container using :

References Digikam::JPEGSettings::convertCompressionForLibJpeg(), Digikam::PNGSettings::convertCompressionForLibPng(), Digikam::DImg::formatToMimeType(), getNeedResetExifOrientation(), getResetExifOrientationAllowed(), ioFileSettings(), isLastChainedTool(), Digikam::DImg::JP2K, Digikam::DImg::JPEG, Digikam::IOFileSettings::JPEG2000Compression, Digikam::IOFileSettings::JPEG2000LossLess, Digikam::IOFileSettings::JPEGSubSampling, outputSuffix(), outputUrl(), Digikam::DImg::PGF, Digikam::IOFileSettings::PGFCompression, Digikam::IOFileSettings::PGFLossLess, Digikam::DImg::PNG, Digikam::DImg::RAW, Digikam::DImg::TIFF, and Digikam::IOFileSettings::TIFFCompression.

◆ setBranchHistory()

void Digikam::BatchTool::setBranchHistory ( bool  branch = true)

Applies only when the file is actually saved on disk, and takes the history since the loading from disk to set the first added step as creating a branch.

◆ setDRawDecoderSettings()

void Digikam::BatchTool::setDRawDecoderSettings ( const DRawDecoderSettings &  settings)

Set-up RAW decoding settings no use during tool operations.

References settings().

◆ setErrorDescription()

void Digikam::BatchTool::setErrorDescription ( const QString &  errmsg)
protected

Set string to describe an error which appear during apply() method.

◆ setImageData()

void Digikam::BatchTool::setImageData ( const DImg &  img)

Manage instance of current image data container loaded by this tool.

◆ setInputUrl()

void Digikam::BatchTool::setInputUrl ( const QUrl &  inputUrl)

Manage current input url processed by this tool.

References inputUrl().

◆ setIOFileSettings()

void Digikam::BatchTool::setIOFileSettings ( const IOFileSettings &  settings)

Set-up IOFile settings no use during tool operations.

References settings().

◆ setItemInfo()

void Digikam::BatchTool::setItemInfo ( const ItemInfo &  info)

Manage instance of current image info loaded by this tool.

◆ setLastChainedTool()

void Digikam::BatchTool::setLastChainedTool ( bool  last)

Manage flag properties to indicate if this tool is last one to process on current item.

◆ setNeedResetExifOrientation()

void Digikam::BatchTool::setNeedResetExifOrientation ( bool  reset)

Set that the Exif orientation flag should be reset to NORMAL after tool operation

Referenced by DigikamBqmFlipPlugin::Flip::registerSettingsWidget(), and DigikamBqmRotatePlugin::Rotate::registerSettingsWidget().

◆ setOutputUrl()

void Digikam::BatchTool::setOutputUrl ( const QUrl &  outputUrl)

Manage current output url processed by this tool.

References outputUrl().

Referenced by setOutputUrlFromInputUrl().

◆ setOutputUrlFromInputUrl()

void Digikam::BatchTool::setOutputUrlFromInputUrl ( )

Set output url using input url content + annotation based on time stamp + file extension defined by outputSuffix(). if outputSuffix() return null, file extension is the same than original.

References inputUrl(), Digikam::SafeTemporaryFile::open(), outputSuffix(), Digikam::SafeTemporaryFile::safeFilePath(), setOutputUrl(), suffix, and workingUrl().

◆ setPlugin()

void Digikam::BatchTool::setPlugin ( DPluginBqm *const  plugin)

References plugin(), setToolDescription(), setToolIcon(), setToolTitle(), and signalVisible().

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(), Digikam::RestorationPlugin::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().

◆ setRawLoadingRules()

void Digikam::BatchTool::setRawLoadingRules ( QueueSettings::RawLoadingRule  rule)

Set that RAW files loading rule to use (demosaicing or JPEG embedded).

◆ setResetExifOrientationAllowed()

void Digikam::BatchTool::setResetExifOrientationAllowed ( bool  reset)

Set that the Exif orientation flag is allowed be reset to NORMAL after tool operation

◆ setSaveAsNewVersion()

void Digikam::BatchTool::setSaveAsNewVersion ( bool  fork = true)

Sets if the history added by tools shall be made a branch (new version).

◆ setSettings()

void Digikam::BatchTool::setSettings ( const BatchToolSettings &  settings)

Manage settings values to tool. See BatchToolSettings container for details.

References settings(), and signalAssignSettings2Widget().

Referenced by slotSettingsChanged().

◆ settings()

BatchToolSettings Digikam::BatchTool::settings ( ) const

Referenced by apply(), DigikamBqmAutoCorrectionPlugin::AutoCorrection::defaultSettings(), DigikamBqmConvertToDngPlugin::ConvertToDNG::defaultSettings(), DigikamBqmConvertToHeifPlugin::ConvertToHEIF::defaultSettings(), DigikamBqmConvertToJp2Plugin::ConvertToJP2::defaultSettings(), DigikamBqmConvertToJpegPlugin::ConvertToJPEG::defaultSettings(), DigikamBqmConvertToPgfPlugin::ConvertToPGF::defaultSettings(), DigikamBqmConvertToPngPlugin::ConvertToPNG::defaultSettings(), DigikamBqmConvertToTiffPlugin::ConvertToTIFF::defaultSettings(), DigikamBqmUserScriptPlugin::UserScript::defaultSettings(), DigikamBqmWatermarkPlugin::WaterMark::defaultSettings(), DigikamBqmBlurPlugin::Blur::defaultSettings(), Digikam::Restoration::defaultSettings(), DigikamBqmSharpenPlugin::Sharpen::defaultSettings(), DigikamBqmAssignTemplatePlugin::AssignTemplate::defaultSettings(), DigikamBqmRemoveMetadataPlugin::RemoveMetadata::defaultSettings(), DigikamBqmTimeAdjustPlugin::TimeAdjust::defaultSettings(), DigikamBqmCropPlugin::Crop::defaultSettings(), DigikamBqmFlipPlugin::Flip::defaultSettings(), DigikamBqmResizePlugin::Resize::defaultSettings(), DigikamBqmRotatePlugin::Rotate::defaultSettings(), DigikamBqmUserScriptPlugin::UserScript::outputSuffix(), setDRawDecoderSettings(), setIOFileSettings(), setSettings(), and slotSettingsChanged().

◆ settingsWidget()

QWidget * Digikam::BatchTool::settingsWidget ( ) const

Settings widget management. NOTE: do not use these methods in multi-threading part (ActionThread), only in main thread (GUI)

Return dedicated settings widget registered with registerSettingsWidget().

References m_settingsWidget.

Referenced by Digikam::AssignedListView::insertTool().

◆ setToolDescription()

void Digikam::BatchTool::setToolDescription ( const QString &  toolDescription)

Manage Tool description.

References toolDescription().

Referenced by DigikamBqmColorBalancePlugin::ColorBalance::ColorBalance(), DigikamBqmConvert16To8Plugin::Convert16to8::Convert16to8(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::CurvesAdjust(), DigikamBqmLensAutoFixPlugin::LensAutoFix::LensAutoFix(), setPlugin(), and DigikamBqmTimeAdjustPlugin::TimeAdjust::TimeAdjust().

◆ setToolIcon()

void Digikam::BatchTool::setToolIcon ( const QIcon &  icon)

Referenced by setPlugin().

◆ setToolIconName()

void Digikam::BatchTool::setToolIconName ( const QString &  iconName)

Manage Tool icon name.

Referenced by DigikamBqmColorBalancePlugin::ColorBalance::ColorBalance(), DigikamBqmConvert16To8Plugin::Convert16to8::Convert16to8(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::CurvesAdjust(), DigikamBqmLensAutoFixPlugin::LensAutoFix::LensAutoFix(), and DigikamBqmTimeAdjustPlugin::TimeAdjust::TimeAdjust().

◆ setToolTitle()

void Digikam::BatchTool::setToolTitle ( const QString &  toolTitle)

Manage Tool title.

References toolTitle().

Referenced by DigikamBqmColorBalancePlugin::ColorBalance::ColorBalance(), DigikamBqmConvert16To8Plugin::Convert16to8::Convert16to8(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::CurvesAdjust(), DigikamBqmLensAutoFixPlugin::LensAutoFix::LensAutoFix(), setPlugin(), and DigikamBqmTimeAdjustPlugin::TimeAdjust::TimeAdjust().

◆ setWorkingUrl()

void Digikam::BatchTool::setWorkingUrl ( const QUrl &  workingUrl)

Manage current working url used by this tool to process items.

References workingUrl().

◆ signalAssignSettings2Widget

void Digikam::BatchTool::signalAssignSettings2Widget ( )
signal

Only used internally. See registerSettingsWidget() implementation.

Referenced by registerSettingsWidget(), and setSettings().

◆ signalSettingsChanged

void Digikam::BatchTool::signalSettingsChanged ( const BatchToolSettings &  )
signal

Referenced by DigikamBqmBCGCorrectionPlugin::BCGCorrection::registerSettingsWidget(), DigikamBqmBWConvertPlugin::BWConvert::registerSettingsWidget(), DigikamBqmChannelMixerPlugin::ChannelMixer::registerSettingsWidget(), DigikamBqmColorBalancePlugin::ColorBalance::registerSettingsWidget(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::registerSettingsWidget(), DigikamBqmHSLCorrectionPlugin::HSLCorrection::registerSettingsWidget(), DigikamBqmIccConvertPlugin::IccConvert::registerSettingsWidget(), DigikamBqmWhiteBalancePlugin::WhiteBalance::registerSettingsWidget(), DigikamBqmConvertToDngPlugin::ConvertToDNG::registerSettingsWidget(), DigikamBqmConvertToHeifPlugin::ConvertToHEIF::registerSettingsWidget(), DigikamBqmConvertToJp2Plugin::ConvertToJP2::registerSettingsWidget(), DigikamBqmConvertToJpegPlugin::ConvertToJPEG::registerSettingsWidget(), DigikamBqmConvertToPgfPlugin::ConvertToPGF::registerSettingsWidget(), DigikamBqmConvertToPngPlugin::ConvertToPNG::registerSettingsWidget(), DigikamBqmConvertToTiffPlugin::ConvertToTIFF::registerSettingsWidget(), DigikamBqmBorderPlugin::Border::registerSettingsWidget(), DigikamBqmTexturePlugin::Texture::registerSettingsWidget(), DigikamBqmAntiVignettingPlugin::AntiVignetting::registerSettingsWidget(), DigikamBqmHotPixelsPlugin::HotPixels::registerSettingsWidget(), DigikamBqmLensAutoFixPlugin::LensAutoFix::registerSettingsWidget(), DigikamBqmLocalContrastPlugin::LocalContrast::registerSettingsWidget(), DigikamBqmNoiseReductionPlugin::NoiseReduction::registerSettingsWidget(), DigikamBqmRestorationPlugin::RedEyeCorrection::registerSettingsWidget(), DigikamBqmSharpenPlugin::Sharpen::registerSettingsWidget(), DigikamBqmColorFXPlugin::ColorFX::registerSettingsWidget(), DigikamBqmFilmGrainPlugin::FilmGrain::registerSettingsWidget(), DigikamBqmTimeAdjustPlugin::TimeAdjust::registerSettingsWidget(), DigikamBqmRotatePlugin::Rotate::registerSettingsWidget(), and slotSettingsChanged().

◆ signalVisible

void Digikam::BatchTool::signalVisible ( bool  )
signal

Referenced by setPlugin().

◆ slotAssignSettings2Widget

virtual void Digikam::BatchTool::slotAssignSettings2Widget ( )
protectedpure virtualslot

Re-implement this method to customize how all settings values must be assigned to settings widget. This method is called by setSettings() through signalAssignSettings2Widget().

Referenced by registerSettingsWidget().

◆ slotResetSettingsToDefault

void Digikam::BatchTool::slotResetSettingsToDefault ( )
slot

References defaultSettings(), and slotSettingsChanged().

◆ slotSettingsChanged [1/2]

virtual void Digikam::BatchTool::slotSettingsChanged ( )
protectedpure virtualslot

Referenced by slotResetSettingsToDefault().

◆ slotSettingsChanged [2/2]

void Digikam::BatchTool::slotSettingsChanged ( const BatchToolSettings &  settings)
slot

References setSettings(), settings(), and signalSettingsChanged().

◆ toolDescription()

QString Digikam::BatchTool::toolDescription ( ) const

Referenced by Digikam::Task::run(), setToolDescription(), and Digikam::ToolListViewItem::ToolListViewItem().

◆ toolGroup()

BatchTool::BatchToolGroup Digikam::BatchTool::toolGroup ( ) const

Return group of tool. See BatchToolGroup enum for details.

Referenced by Digikam::ToolsListView::addTool(), Digikam::ToolsView::addTool(), Digikam::BatchToolsFactory::findTool(), Digikam::ToolsView::removeTool(), and toolGroupToString().

◆ toolGroupToString()

QString Digikam::BatchTool::toolGroupToString ( ) const

Return group of tool name as string.

References BaseTool, ColorTool, ConvertTool, CustomTool, DecorateTool, EnhanceTool, FiltersTool, MetadataTool, toolGroup(), and TransformTool.

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

◆ toolIcon()

QIcon Digikam::BatchTool::toolIcon ( ) const

Referenced by Digikam::Task::run(), Digikam::AssignedListViewItem::setToolSet(), and Digikam::ToolListViewItem::ToolListViewItem().

◆ toolOperations()

virtual bool Digikam::BatchTool::toolOperations ( )
protectedpure virtual

Re-implement this method to customize all batch operations done by this tool. This method is called by apply().

Referenced by apply().

◆ toolTitle()

QString Digikam::BatchTool::toolTitle ( ) const

Referenced by apply(), Digikam::Task::run(), Digikam::AssignedListViewItem::setToolSet(), setToolTitle(), and Digikam::ToolListViewItem::ToolListViewItem().

◆ toolVersion()

virtual int Digikam::BatchTool::toolVersion ( ) const
inlinevirtual

Return version of tool. By default, ID is 1. Re-implement this method and increase this ID when tool settings change.

Referenced by Digikam::WorkflowManager::load().

◆ workingUrl()

QUrl Digikam::BatchTool::workingUrl ( ) const

Referenced by setOutputUrlFromInputUrl(), and setWorkingUrl().

Member Data Documentation

◆ m_settingsWidget

QWidget* Digikam::BatchTool::m_settingsWidget
protected

Host settings widget instance.

Referenced by BatchTool(), deleteSettingsWidget(), registerSettingsWidget(), DigikamBqmAutoCorrectionPlugin::AutoCorrection::registerSettingsWidget(), DigikamBqmBCGCorrectionPlugin::BCGCorrection::registerSettingsWidget(), DigikamBqmBWConvertPlugin::BWConvert::registerSettingsWidget(), DigikamBqmChannelMixerPlugin::ChannelMixer::registerSettingsWidget(), DigikamBqmColorBalancePlugin::ColorBalance::registerSettingsWidget(), DigikamBqmCurvesAdjustPlugin::CurvesAdjust::registerSettingsWidget(), DigikamBqmHSLCorrectionPlugin::HSLCorrection::registerSettingsWidget(), DigikamBqmIccConvertPlugin::IccConvert::registerSettingsWidget(), DigikamBqmWhiteBalancePlugin::WhiteBalance::registerSettingsWidget(), DigikamBqmConvertToDngPlugin::ConvertToDNG::registerSettingsWidget(), DigikamBqmConvertToHeifPlugin::ConvertToHEIF::registerSettingsWidget(), DigikamBqmConvertToJp2Plugin::ConvertToJP2::registerSettingsWidget(), DigikamBqmConvertToJpegPlugin::ConvertToJPEG::registerSettingsWidget(), DigikamBqmConvertToPgfPlugin::ConvertToPGF::registerSettingsWidget(), DigikamBqmConvertToPngPlugin::ConvertToPNG::registerSettingsWidget(), DigikamBqmConvertToTiffPlugin::ConvertToTIFF::registerSettingsWidget(), DigikamBqmUserScriptPlugin::UserScript::registerSettingsWidget(), DigikamBqmBorderPlugin::Border::registerSettingsWidget(), DigikamBqmTexturePlugin::Texture::registerSettingsWidget(), DigikamBqmWatermarkPlugin::WaterMark::registerSettingsWidget(), DigikamBqmAntiVignettingPlugin::AntiVignetting::registerSettingsWidget(), DigikamBqmBlurPlugin::Blur::registerSettingsWidget(), DigikamBqmHotPixelsPlugin::HotPixels::registerSettingsWidget(), DigikamBqmLensAutoFixPlugin::LensAutoFix::registerSettingsWidget(), DigikamBqmLocalContrastPlugin::LocalContrast::registerSettingsWidget(), DigikamBqmNoiseReductionPlugin::NoiseReduction::registerSettingsWidget(), DigikamBqmRestorationPlugin::RedEyeCorrection::registerSettingsWidget(), Digikam::Restoration::registerSettingsWidget(), DigikamBqmSharpenPlugin::Sharpen::registerSettingsWidget(), DigikamBqmColorFXPlugin::ColorFX::registerSettingsWidget(), DigikamBqmFilmGrainPlugin::FilmGrain::registerSettingsWidget(), DigikamBqmAssignTemplatePlugin::AssignTemplate::registerSettingsWidget(), DigikamBqmRemoveMetadataPlugin::RemoveMetadata::registerSettingsWidget(), DigikamBqmTimeAdjustPlugin::TimeAdjust::registerSettingsWidget(), DigikamBqmCropPlugin::Crop::registerSettingsWidget(), DigikamBqmFlipPlugin::Flip::registerSettingsWidget(), DigikamBqmResizePlugin::Resize::registerSettingsWidget(), DigikamBqmRotatePlugin::Rotate::registerSettingsWidget(), and settingsWidget().

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