Public Types
enum	Type { NoOperation , Rotate90 , Rotate180 , Rotate270 , FlipHorizontally , FlipVertically , Crop , Resize , ConvertTo8Bit , ConvertTo16Bit }

Public Member Functions
void	apply (DImg &image) const

DImgThreadedFilter *	createThreadedFilter (DImg const orgImage, QObject const parent=nullptr) const

DImgThreadedFilter *	createThreadedFilter (QObject *const parent=nullptr) const

	DImgBuiltinFilter ()

	DImgBuiltinFilter (const FilterAction &action)

	DImgBuiltinFilter (Type type, const QVariant &arg=QVariant())

QString	displayableName () const

FilterAction	filterAction () const

QString	filterIcon () const

QString	i18nDisplayableName () const

bool	isReversible () const

bool	isValid () const

DImgBuiltinFilter	reverseFilter () const

void	setAction (const FilterAction &action)

void	setAction (Type type, const QVariant &arg=QVariant())

Static Public Member Functions
static QString	filterIcon (const QString &filterIdentifier)

static QString	i18nDisplayableName (const QString &filterIdentifier)

static bool	isSupported (const QString &filterIdentifier)

static bool	isSupported (const QString &filterIdentifier, int version)

static QStringList	supportedFilters ()

static QList< int >	supportedVersions (const QString &filterIdentifier)

Protected Attributes
QVariant	m_arg

Type	m_type

Member Enumeration Documentation

◆ Type

enum Digikam::DImgBuiltinFilter::Type

Enumerator
NoOperation
Rotate90
Rotate180
Rotate270
FlipHorizontally
FlipVertically
Crop	Argument: QRect.
Resize	Argument: QSize.
ConvertTo8Bit
ConvertTo16Bit

Constructor & Destructor Documentation

◆ DImgBuiltinFilter() [1/3]

Digikam::DImgBuiltinFilter::DImgBuiltinFilter ( )

Create a filter performing no operation

Referenced by reverseFilter().

◆ DImgBuiltinFilter() [2/3]

Digikam::DImgBuiltinFilter::DImgBuiltinFilter ( const FilterAction & action )

explicit

Create a filter for the given action. If the action is not supported, the filter will perform no operation.

References setAction().

◆ DImgBuiltinFilter() [3/3]

Digikam::DImgBuiltinFilter::DImgBuiltinFilter	(	Type	type,
		const QVariant &	arg = `QVariant()`
	)

explicit

Create a filter of the given type. See documentation of Type for required arguments.

References setAction().

Member Function Documentation

◆ apply()

void Digikam::DImgBuiltinFilter::apply ( DImg & image ) const

Apply the described change to the given image reference

References ConvertTo16Bit, ConvertTo8Bit, Digikam::DImg::convertToEightBit(), Digikam::DImg::convertToSixteenBit(), Digikam::DImg::crop(), Crop, Digikam::DImg::flip(), FlipHorizontally, FlipVertically, Digikam::DImg::HORIZONTAL, m_arg, m_type, NoOperation, Digikam::DImg::resize(), Resize, Digikam::DImg::ROT180, Digikam::DImg::ROT270, Digikam::DImg::ROT90, Digikam::DImg::rotate(), Rotate180, Rotate270, Rotate90, and Digikam::DImg::VERTICAL.

Referenced by Digikam::EditorCore::Private::applyBuiltinFilter(), Digikam::BatchTool::applyFilter(), Digikam::FilterActionFilter::filterImage(), and Digikam::UndoManager::putImageDataAndHistory().

◆ createThreadedFilter() [1/2]

DImgThreadedFilter * Digikam::DImgBuiltinFilter::createThreadedFilter	(	DImg *const	orgImage,
		QObject *const	parent = `nullptr`
	)		const

◆ createThreadedFilter() [2/2]

DImgThreadedFilter * Digikam::DImgBuiltinFilter::createThreadedFilter ( QObject *const parent = nullptr ) const

Returns a DImgThreadedFilter which executes this builtin action.

◆ displayableName()

QString Digikam::DImgBuiltinFilter::displayableName ( ) const

Returns a displayableName for this filter

References ConvertTo16Bit, ConvertTo8Bit, Crop, FlipHorizontally, FlipVertically, m_type, NoOperation, Resize, Rotate180, Rotate270, and Rotate90.

Referenced by filterAction(), and i18nDisplayableName().

◆ filterAction()

FilterAction Digikam::DImgBuiltinFilter::filterAction ( ) const

NOTE: The following methods are also accessed by the more general DImgFilterManager methods, so you usually do not need to call these directly. Returns the FilterAction describing this filter.

References Digikam::FilterAction::addParameter(), ConvertTo16Bit, ConvertTo8Bit, Crop, displayableName(), FlipHorizontally, FlipVertically, m_arg, m_type, NoOperation, Resize, Rotate180, Rotate270, Rotate90, and Digikam::FilterAction::setDisplayableName().