#include <batchtool.h>
◆ 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.
|
◆ 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).
◆ ~BatchTool()
Digikam::BatchTool::~BatchTool |
( |
| ) |
|
|
override |
◆ apply()
bool Digikam::BatchTool::apply |
( |
| ) |
|
◆ applyFilter() [1/2]
◆ applyFilter() [2/2]
◆ applyFilterChangedProperties()
◆ 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.
◆ 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.
Referenced by Digikam::ActionTask::run().
◆ defaultSettings()
◆ deleteSettingsWidget()
void Digikam::BatchTool::deleteSettingsWidget |
( |
| ) |
|
◆ 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 |
◆ ioFileSettings()
Return IOFile settings used during tool operations.
Referenced by savefromDImg().
◆ isCancelled()
bool Digikam::BatchTool::isCancelled |
( |
| ) |
const |
|
protected |
◆ isLastChainedTool()
bool Digikam::BatchTool::isLastChainedTool |
( |
| ) |
const |
◆ isRawFile()
bool Digikam::BatchTool::isRawFile |
( |
const QUrl & |
url | ) |
const |
|
protected |
◆ loadToDImg()
bool Digikam::BatchTool::loadToDImg |
( |
| ) |
const |
◆ outputSuffix()
QString Digikam::BatchTool::outputSuffix |
( |
| ) |
const |
|
virtual |
◆ outputUrl()
QUrl Digikam::BatchTool::outputUrl |
( |
| ) |
const |
◆ plugin()
◆ rawDecodingSettings()
Return RAW decoding settings used during tool operations.
Referenced by loadToDImg().
◆ registerSettingsWidget()
void Digikam::BatchTool::registerSettingsWidget |
( |
| ) |
|
|
virtual |
◆ savefromDImg()
bool Digikam::BatchTool::savefromDImg |
( |
| ) |
const |
Save image data from instance of internal DImg container using :
References Digikam::DImgLoader::convertCompressionForLibJpeg(), Digikam::DImgLoader::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()
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
◆ setOutputUrl()
void Digikam::BatchTool::setOutputUrl |
( |
const QUrl & |
outputUrl | ) |
|
◆ setOutputUrlFromInputUrl()
void Digikam::BatchTool::setOutputUrlFromInputUrl |
( |
| ) |
|
◆ setPlugin()
void Digikam::BatchTool::setPlugin |
( |
DPluginBqm *const |
plugin | ) |
|
◆ setRawLoadingRules()
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()
◆ settings()
◆ settingsWidget()
QWidget * Digikam::BatchTool::settingsWidget |
( |
| ) |
const |
◆ setToolDescription()
void Digikam::BatchTool::setToolDescription |
( |
const QString & |
toolDescription | ) |
|
◆ setToolIcon()
void Digikam::BatchTool::setToolIcon |
( |
const QIcon & |
icon | ) |
|
◆ setToolIconName()
void Digikam::BatchTool::setToolIconName |
( |
const QString & |
iconName | ) |
|
◆ setToolTitle()
void Digikam::BatchTool::setToolTitle |
( |
const QString & |
toolTitle | ) |
|
◆ 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 |
◆ signalSettingsChanged
◆ signalVisible
void Digikam::BatchTool::signalVisible |
( |
bool |
| ) |
|
|
signal |
◆ slotAssignSettings2Widget
virtual void Digikam::BatchTool::slotAssignSettings2Widget |
( |
| ) |
|
|
protectedpure virtualslot |
◆ slotResetSettingsToDefault
void Digikam::BatchTool::slotResetSettingsToDefault |
( |
| ) |
|
|
slot |
◆ slotSettingsChanged [1/2]
virtual void Digikam::BatchTool::slotSettingsChanged |
( |
| ) |
|
|
protectedpure virtualslot |
◆ slotSettingsChanged [2/2]
◆ toolDescription()
QString Digikam::BatchTool::toolDescription |
( |
| ) |
const |
◆ toolGroup()
◆ toolGroupToString()
QString Digikam::BatchTool::toolGroupToString |
( |
| ) |
const |
◆ toolIcon()
QIcon Digikam::BatchTool::toolIcon |
( |
| ) |
const |
◆ 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 |
◆ 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 |
◆ m_settingsWidget
QWidget* Digikam::BatchTool::m_settingsWidget = nullptr |
|
protected |
The documentation for this class was generated from the following files: