digiKam
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DigikamBqmAutoCorrectionPlugin::AutoCorrection Class Reference
+ Inheritance diagram for DigikamBqmAutoCorrectionPlugin::AutoCorrection:

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 ()
 
 AutoCorrection (QObject *const parent=nullptr)
 
virtual void cancel ()
 
BatchTool * clone (QObject *const parent=nullptr) const override
 
BatchToolSettings defaultSettings () override
 
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
 
void registerSettingsWidget () override
 
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
 
 ~AutoCorrection () override
 

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)
 

Protected Attributes

QWidget * m_settingsWidget
 

Member Enumeration Documentation

◆ BatchToolGroup

enum Digikam::BatchTool::BatchToolGroup
inherited
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

◆ AutoCorrection()

DigikamBqmAutoCorrectionPlugin::AutoCorrection::AutoCorrection ( QObject *const  parent = nullptr)
explicit

Referenced by clone().

◆ ~AutoCorrection()

DigikamBqmAutoCorrectionPlugin::AutoCorrection::~AutoCorrection ( )
override

Member Function Documentation

◆ apply()

bool Digikam::BatchTool::apply ( )
inherited

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

References Digikam::BatchTool::inputUrl(), Digikam::BatchTool::outputUrl(), Digikam::BatchTool::settings(), Digikam::BatchTool::toolOperations(), and Digikam::BatchTool::toolTitle().

◆ applyFilter() [1/2]

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

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

◆ applyFilter() [2/2]

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

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(), Digikam::BatchTool::isCancelled(), and Digikam::DImgThreadedFilter::startFilterDirectly().

◆ applyFilterChangedProperties()

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

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

◆ cancel()

void Digikam::BatchTool::cancel ( )
virtualinherited

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

BatchTool * DigikamBqmAutoCorrectionPlugin::AutoCorrection::clone ( QObject *const  parent = nullptr) const
overridevirtual

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.

Implements Digikam::BatchTool.

References AutoCorrection().

◆ defaultSettings()

BatchToolSettings DigikamBqmAutoCorrectionPlugin::AutoCorrection::defaultSettings ( )
overridevirtual

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

Implements Digikam::BatchTool.

References Digikam::BatchTool::settings().

◆ deleteSettingsWidget()

void Digikam::BatchTool::deleteSettingsWidget ( )
inherited

Delete dedicated settings widget registered with registerSettingsWidget().

References Digikam::BatchTool::m_settingsWidget.

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

◆ errorDescription()

QString Digikam::BatchTool::errorDescription ( ) const
inherited

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

◆ getBranchHistory()

bool Digikam::BatchTool::getBranchHistory ( ) const
inherited

◆ getNeedResetExifOrientation()

bool Digikam::BatchTool::getNeedResetExifOrientation ( ) const
inherited

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

Referenced by Digikam::BatchTool::savefromDImg().

◆ getResetExifOrientationAllowed()

bool Digikam::BatchTool::getResetExifOrientationAllowed ( ) const
inherited

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

Referenced by Digikam::BatchTool::savefromDImg().

◆ image()

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

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

◆ imageData()

DImg Digikam::BatchTool::imageData ( ) const
inherited

◆ imageInfo()

ItemInfo Digikam::BatchTool::imageInfo ( ) const
inherited

◆ inputUrl()

QUrl Digikam::BatchTool::inputUrl ( ) const
inherited

Referenced by Digikam::BatchTool::apply(), Digikam::BatchTool::loadToDImg(), Digikam::BatchTool::setInputUrl(), and Digikam::BatchTool::setOutputUrlFromInputUrl().

◆ ioFileSettings()

IOFileSettings Digikam::BatchTool::ioFileSettings ( ) const
inherited

Return IOFile settings used during tool operations.

Referenced by Digikam::BatchTool::savefromDImg().

◆ isCancelled()

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

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

Referenced by Digikam::BatchTool::applyFilter(), and Digikam::BatchTool::applyFilterChangedProperties().

◆ isLastChainedTool()

bool Digikam::BatchTool::isLastChainedTool ( ) const
inherited

Referenced by Digikam::BatchTool::savefromDImg().

◆ isRawFile()

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

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

References Digikam::DRawDecoder::rawFiles().

Referenced by Digikam::BatchTool::loadToDImg().

◆ loadToDImg()

bool Digikam::BatchTool::loadToDImg ( ) const
inherited

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

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

◆ outputSuffix()

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

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 Digikam::BatchTool::savefromDImg(), Digikam::BatchTool::setOutputUrlFromInputUrl(), and Digikam::AssignedBatchTools::targetSuffix().

◆ outputUrl()

QUrl Digikam::BatchTool::outputUrl ( ) const
inherited

Referenced by Digikam::BatchTool::apply(), Digikam::BatchTool::savefromDImg(), and Digikam::BatchTool::setOutputUrl().

◆ plugin()

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

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

◆ rawDecodingSettings()

DRawDecoderSettings Digikam::BatchTool::rawDecodingSettings ( ) const
inherited

Return RAW decoding settings used during tool operations.

Referenced by Digikam::BatchTool::loadToDImg().

◆ registerSettingsWidget()

void DigikamBqmAutoCorrectionPlugin::AutoCorrection::registerSettingsWidget ( )
overridevirtual

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 from Digikam::BatchTool.

References Digikam::BatchTool::m_settingsWidget, and Digikam::DHBox::setStretchFactor().

◆ savefromDImg()

bool Digikam::BatchTool::savefromDImg ( ) const
inherited

Save image data from instance of internal DImg container using :

References Digikam::JPEGSettings::convertCompressionForLibJpeg(), Digikam::PNGSettings::convertCompressionForLibPng(), Digikam::DImg::formatToMimeType(), Digikam::BatchTool::getNeedResetExifOrientation(), Digikam::BatchTool::getResetExifOrientationAllowed(), Digikam::BatchTool::ioFileSettings(), Digikam::BatchTool::isLastChainedTool(), Digikam::DImg::JP2K, Digikam::DImg::JPEG, Digikam::IOFileSettings::JPEG2000Compression, Digikam::IOFileSettings::JPEG2000LossLess, Digikam::IOFileSettings::JPEGSubSampling, Digikam::BatchTool::outputSuffix(), Digikam::BatchTool::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)
inherited

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)
inherited

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

References Digikam::BatchTool::settings().

◆ setErrorDescription()

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

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

◆ setImageData()

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

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

◆ setInputUrl()

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

Manage current input url processed by this tool.

References Digikam::BatchTool::inputUrl().

◆ setIOFileSettings()

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

Set-up IOFile settings no use during tool operations.

References Digikam::BatchTool::settings().

◆ setItemInfo()

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

Manage instance of current image info loaded by this tool.

◆ setLastChainedTool()

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

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

◆ setNeedResetExifOrientation()

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

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)
inherited

Manage current output url processed by this tool.

References Digikam::BatchTool::outputUrl().

Referenced by Digikam::BatchTool::setOutputUrlFromInputUrl().

◆ setOutputUrlFromInputUrl()

void Digikam::BatchTool::setOutputUrlFromInputUrl ( )
inherited

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 Digikam::BatchTool::inputUrl(), Digikam::SafeTemporaryFile::open(), Digikam::BatchTool::outputSuffix(), Digikam::SafeTemporaryFile::safeFilePath(), Digikam::BatchTool::setOutputUrl(), suffix, and Digikam::BatchTool::workingUrl().

◆ setPlugin()

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

References Digikam::BatchTool::plugin(), Digikam::BatchTool::setToolDescription(), Digikam::BatchTool::setToolIcon(), Digikam::BatchTool::setToolTitle(), and Digikam::BatchTool::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)
inherited

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

◆ setResetExifOrientationAllowed()

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

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

◆ setSaveAsNewVersion()

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

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

◆ setSettings()

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

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

References Digikam::BatchTool::settings(), and Digikam::BatchTool::signalAssignSettings2Widget().

Referenced by Digikam::BatchTool::slotSettingsChanged().

◆ settings()

BatchToolSettings Digikam::BatchTool::settings ( ) const
inherited

Referenced by Digikam::BatchTool::apply(), 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(), Digikam::BatchTool::setDRawDecoderSettings(), Digikam::BatchTool::setIOFileSettings(), Digikam::BatchTool::setSettings(), and Digikam::BatchTool::slotSettingsChanged().

◆ settingsWidget()

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

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 Digikam::BatchTool::m_settingsWidget.

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

◆ setToolDescription()

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

Manage Tool description.

References Digikam::BatchTool::toolDescription().

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

◆ setToolIcon()

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

Referenced by Digikam::BatchTool::setPlugin().

◆ setToolIconName()

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

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)
inherited

Manage Tool title.

References Digikam::BatchTool::toolTitle().

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

◆ setWorkingUrl()

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

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

References Digikam::BatchTool::workingUrl().

◆ signalAssignSettings2Widget

void Digikam::BatchTool::signalAssignSettings2Widget ( )
signalinherited

Only used internally. See registerSettingsWidget() implementation.

Referenced by Digikam::BatchTool::registerSettingsWidget(), and Digikam::BatchTool::setSettings().

◆ signalSettingsChanged

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

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 Digikam::BatchTool::slotSettingsChanged().

◆ signalVisible

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

Referenced by Digikam::BatchTool::setPlugin().

◆ slotResetSettingsToDefault

void Digikam::BatchTool::slotResetSettingsToDefault ( )
slotinherited

References Digikam::BatchTool::defaultSettings(), and Digikam::BatchTool::slotSettingsChanged().

◆ slotSettingsChanged

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

References Digikam::BatchTool::setSettings(), Digikam::BatchTool::settings(), and Digikam::BatchTool::signalSettingsChanged().

◆ toolDescription()

QString Digikam::BatchTool::toolDescription ( ) const
inherited

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

◆ toolGroup()

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

Return group of tool. See BatchToolGroup enum for details.

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

◆ toolGroupToString()

QString Digikam::BatchTool::toolGroupToString ( ) const
inherited

Return group of tool name as string.

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

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

◆ toolIcon()

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

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

◆ toolTitle()

QString Digikam::BatchTool::toolTitle ( ) const
inherited

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

◆ toolVersion()

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

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
inherited

Referenced by Digikam::BatchTool::setOutputUrlFromInputUrl(), and Digikam::BatchTool::setWorkingUrl().

Member Data Documentation

◆ m_settingsWidget

QWidget* Digikam::BatchTool::m_settingsWidget
protectedinherited

Host settings widget instance.

Referenced by Digikam::BatchTool::BatchTool(), Digikam::BatchTool::deleteSettingsWidget(), Digikam::BatchTool::registerSettingsWidget(), 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 Digikam::BatchTool::settingsWidget().

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