Inheritance diagram for Digikam::ImportFilterModel:

Public Types
enum	AdditionalRoles { CategoryDisplayRole = 0x17CE990A , CategorySortRole = 0x27857E60 }

enum	ImportFilterModelRoles { CategorizationModeRole = ImportItemModel::FilterModelRoles + 1 , SortOrderRole = ImportItemModel::FilterModelRoles + 2 , CategoryFormatRole = ImportItemModel::FilterModelRoles + 3 , CategoryDateRole = ImportItemModel::FilterModelRoles + 4 , ImportFilterModelPointerRole = ImportItemModel::FilterModelRoles + 50 }

Public Slots
void	setCameraThumbsController (CameraThumbsCtrl *const thumbsCtrl)

void	setCategorizationMode (CamItemSortSettings::CategorizationMode mode)

void	setFilter (Filter *)

void	setSortOrder (CamItemSortSettings::SortOrder order)

void	setSortRole (CamItemSortSettings::SortRole role)

void	setStringTypeNatural (bool natural)

Signals
void	camItemInfosAboutToBeRemoved (const QList< CamItemInfo > &infos)

void	camItemInfosAdded (const QList< CamItemInfo > &infos)

Public Member Functions
qlonglong	camItemId (const QModelIndex &index) const

QList< qlonglong >	camItemIds (const QList< QModelIndex > &indexes) const

CamItemInfo	camItemInfo (const QModelIndex &index) const

QList< CamItemInfo >	camItemInfos (const QList< QModelIndex > &indexes) const

QList< CamItemInfo >	camItemInfosSorted () const

CamItemSortSettings	camItemSortSettings () const

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

ImportFilterModel *	importFilterModel () const override
	Returns this, any chained ImportFilterModel, or 0. More...

	ImportFilterModel (QObject *const parent=nullptr)

QModelIndex	indexForCamItemId (qlonglong id) const

QModelIndex	indexForCamItemInfo (const CamItemInfo &info) const

QModelIndex	indexForPath (const QString &filePath) const

bool	isCategorizedModel () const

QModelIndex	mapFromDirectSourceToSourceImportModel (const QModelIndex &sourceModelIndex) const

QModelIndex	mapFromSourceImportModel (const QModelIndex &importModelIndex) const

QList< QModelIndex >	mapListFromSource (const QList< QModelIndex > &sourceIndexes) const

QList< QModelIndex >	mapListToSource (const QList< QModelIndex > &indexes) const

QModelIndex	mapToSourceImportModel (const QModelIndex &proxyIndex) const

void	setCamItemSortSettings (const CamItemSortSettings &sorter)

void	setCategorizedModel (bool categorizedModel)

void	setSendCamItemInfoSignals (bool sendSignals)
	Enables sending camItemInfosAdded and camItemInfosAboutToBeRemoved. More...

void	setSortCategoriesByNaturalComparison (bool sortCategoriesByNaturalComparison)

void	setSourceFilterModel (ImportSortFilterModel *const sourceModel)

void	setSourceImportModel (ImportItemModel *const sourceModel)

void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override

bool	sortCategoriesByNaturalComparison () const

int	sortColumn () const

Qt::SortOrder	sortOrder () const

ImportSortFilterModel *	sourceFilterModel () const

ImportItemModel *	sourceImportModel () const

	~ImportFilterModel () override

Protected Slots
void	slotProcessAdded (const QList< CamItemInfo > &)

void	slotRowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)

void	slotRowsInserted (const QModelIndex &parent, int start, int end)

Protected Member Functions
virtual QString	categoryIdentifier (const CamItemInfo &info) const

int	compareCategories (const QModelIndex &left, const QModelIndex &right) const override

virtual int	compareInfosCategories (const CamItemInfo &left, const CamItemInfo &right) const

bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override

virtual bool	infosLessThan (const CamItemInfo &left, const CamItemInfo &right) const

bool	lessThan (const QModelIndex &left, const QModelIndex &right) const override

void	setDirectSourceImportModel (ImportItemModel *const sourceModel) override
	Reimplement if needed. Called only when model shall be set as (direct) sourceModel. More...

void	setSourceModel (QAbstractItemModel *sourceModel) override

bool	subSortLessThan (const QModelIndex &left, const QModelIndex &right) const override

Protected Attributes
ImportFilterModelPrivate *const	d_ptr

ImportSortFilterModel *	m_chainedModel

Member Enumeration Documentation

◆ AdditionalRoles

enum Digikam::DCategorizedSortFilterProxyModel::AdditionalRoles

inherited

Enumerator
CategoryDisplayRole	NOTE: use printf "0x%08X\n" $(($RANDOM*$RANDOM)) to define additional roles. This role is used for asking the category to a given index
CategorySortRole	This role is used for sorting categories. You can return a string or a long long value. Strings will be sorted alphabetically while long long will be sorted by their value. Please note that this value won't be shown on the view, is only for sorting purposes. What will be shown as "Category" on the view will be asked with the role CategoryDisplayRole.

◆ ImportFilterModelRoles

enum Digikam::ImportFilterModel::ImportFilterModelRoles

Enumerator
CategorizationModeRole	Returns the current categorization mode.
SortOrderRole	Returns the current sort order.
CategoryFormatRole	Returns the format of the index which is used for category.
CategoryDateRole	Returns the date of the index which is used for category.
ImportFilterModelPointerRole	Returns true if the given camera item is a group leader, and the group is opened.

Constructor & Destructor Documentation

◆ ImportFilterModel()

Digikam::ImportFilterModel::ImportFilterModel ( QObject *const parent = nullptr )

explicit

References d_ptr.

◆ ~ImportFilterModel()

Digikam::ImportFilterModel::~ImportFilterModel ( )

override

Member Function Documentation

◆ camItemId()

qlonglong Digikam::ImportSortFilterModel::camItemId ( const QModelIndex & index ) const

inherited

References Digikam::ImportItemModel::camItemId(), Digikam::ImportSortFilterModel::mapToSourceImportModel(), and Digikam::ImportSortFilterModel::sourceImportModel().

Referenced by Digikam::ImportSortFilterModel::camItemIds(), and Digikam::NoDuplicatesImportFilterModel::filterAcceptsRow().

◆ camItemIds()

QList< qlonglong > Digikam::ImportSortFilterModel::camItemIds ( const QList< QModelIndex > & indexes ) const

inherited

References Digikam::ImportSortFilterModel::camItemId().

◆ camItemInfo()

CamItemInfo Digikam::ImportSortFilterModel::camItemInfo ( const QModelIndex & index ) const

inherited

References Digikam::ImportItemModel::camItemInfo(), Digikam::ImportSortFilterModel::mapToSourceImportModel(), and Digikam::ImportSortFilterModel::sourceImportModel().

Referenced by Digikam::ImportIconView::camItemInfo(), Digikam::ImportSortFilterModel::camItemInfos(), Digikam::ImportSortFilterModel::camItemInfosSorted(), slotRowsAboutToBeRemoved(), and slotRowsInserted().

◆ camItemInfos()

QList< CamItemInfo > Digikam::ImportSortFilterModel::camItemInfos ( const QList< QModelIndex > & indexes ) const

inherited

References Digikam::ImportSortFilterModel::camItemInfo().

◆ camItemInfosAboutToBeRemoved

void Digikam::ImportFilterModel::camItemInfosAboutToBeRemoved ( const QList< CamItemInfo > & infos )

signal

Referenced by slotRowsAboutToBeRemoved().

◆ camItemInfosAdded

void Digikam::ImportFilterModel::camItemInfosAdded ( const QList< CamItemInfo > & infos )

signal

Changes the current image filter settings and refilters. Changes the current image sort settings and resorts. These signals need to be explicitly enabled with setSendItemInfoSignals().

Referenced by slotRowsInserted().

◆ camItemInfosSorted()

QList< CamItemInfo > Digikam::ImportSortFilterModel::camItemInfosSorted ( ) const

inherited

Returns a list of all camera infos, sorted according to this model. If you do not need a sorted list, use ImportItemModel's camItemInfo() method.

References Digikam::ImportSortFilterModel::camItemInfo().

◆ camItemSortSettings()

CamItemSortSettings Digikam::ImportFilterModel::camItemSortSettings ( ) const

◆ categoryIdentifier()

QString Digikam::ImportFilterModel::categoryIdentifier ( const CamItemInfo & info ) const

protectedvirtual

Returns a unique identifier for the category if info. The string need not be for user display.

References Digikam::CamItemSortSettings::CategoryByDate, Digikam::CamItemSortSettings::CategoryByFolder, Digikam::CamItemSortSettings::CategoryByFormat, Digikam::CamItemInfo::ctime, Digikam::CamItemInfo::folder, Digikam::CamItemInfo::mime, and Digikam::CamItemSortSettings::NoCategories.

Referenced by data().

◆ compareCategories()

int Digikam::ImportFilterModel::compareCategories	(	const QModelIndex &	left,
		const QModelIndex &	right
	)		const

overrideprotectedvirtual

This method compares the category of the left index with the category of the right index.

Internally and if not reimplemented, this method will ask for left and right models for role CategorySortRole. In order to correctly sort categories, the data() method of the model should return a qlonglong (or numeric) value, or a QString object. QString objects will be sorted with QString::localeAwareCompare if sortCategoriesByNaturalComparison() is true.

Note: Please have present that: QString(QChar(QChar::ObjectReplacementCharacter)) > QString(QChar(QChar::ReplacementCharacter)) > [ all possible strings ] > QString();

This means that QString() will be sorted the first one, while QString(QChar(QChar::ObjectReplacementCharacter)) and QString(QChar(QChar::ReplacementCharacter)) will be sorted in last position.

Warning: Please note that data() method of the model should return always information of the same type. If you return a QString for an index, you should return always QStrings for all indexes for role CategorySortRole in order to correctly sort categories. You can't mix by returning a QString for one index, and a qlonglong for other.

Note: If you need a more complex layout, you will have to reimplement this method.

Returns: A negative value if the category of left should be placed before the category of right. 0 if left and right are on the same category, and a positive value if the category of left should be placed after the category of right.

Reimplemented from Digikam::DCategorizedSortFilterProxyModel.

References compareInfosCategories().

◆ compareInfosCategories()

int Digikam::ImportFilterModel::compareInfosCategories	(	const CamItemInfo &	left,
		const CamItemInfo &	right
	)		const

protectedvirtual

Reimplement to customize category sorting, Return negative if category of left < category right, Return 0 if left and right are in the same category, else return positive.

Referenced by compareCategories().

◆ data()

QVariant Digikam::ImportFilterModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

override

References CategorizationModeRole, CategoryDateRole, Digikam::DCategorizedSortFilterProxyModel::CategoryDisplayRole, CategoryFormatRole, categoryIdentifier(), ImportFilterModelPointerRole, and SortOrderRole.

◆ filterAcceptsRow()

bool Digikam::ImportFilterModel::filterAcceptsRow	(	int	source_row,
		const QModelIndex &	source_parent
	)		const

overrideprotected

◆ importFilterModel()

ImportFilterModel * Digikam::ImportFilterModel::importFilterModel ( ) const

overridevirtual

Returns this, any chained ImportFilterModel, or 0.

Reimplemented from Digikam::ImportSortFilterModel.

◆ indexForCamItemId()

QModelIndex Digikam::ImportSortFilterModel::indexForCamItemId ( qlonglong id ) const

inherited

References Digikam::ImportSortFilterModel::mapFromSourceImportModel(), and Digikam::ImportSortFilterModel::sourceImportModel().

◆ indexForCamItemInfo()

QModelIndex Digikam::ImportSortFilterModel::indexForCamItemInfo ( const CamItemInfo & info ) const

inherited

References Digikam::ImportSortFilterModel::mapFromSourceImportModel(), and Digikam::ImportSortFilterModel::sourceImportModel().

◆ indexForPath()

QModelIndex Digikam::ImportSortFilterModel::indexForPath ( const QString & filePath ) const

inherited

References Digikam::ImportSortFilterModel::mapFromSourceImportModel(), and Digikam::ImportSortFilterModel::sourceImportModel().

Referenced by Digikam::ImportIconView::camItemInfo(), and Digikam::ImportIconView::camItemInfoRef().

◆ infosLessThan()

bool Digikam::ImportFilterModel::infosLessThan	(	const CamItemInfo &	left,
		const CamItemInfo &	right
	)		const

protectedvirtual

Reimplement to customize sorting. Do not take categories into account here.

Referenced by subSortLessThan().

◆ isCategorizedModel()

bool Digikam::DCategorizedSortFilterProxyModel::isCategorizedModel ( ) const

inherited

Returns: whether the model is categorized or not. Disabled by default.

References Digikam::DCategorizedSortFilterProxyModel::Private::categorizedModel.

◆ lessThan()

bool Digikam::DCategorizedSortFilterProxyModel::lessThan	(	const QModelIndex &	left,
		const QModelIndex &	right
	)		const

overrideprotectedinherited

Overridden from QSortFilterProxyModel. If you are subclassing DCategorizedSortFilterProxyModel, you will probably not need to reimplement this method.

It calls compareCategories() to sort by category. If the both items are in the same category (i.e. compareCategories returns 0), then subSortLessThan is called.

Returns: Returns true if the item left is less than the item right when sorting.

Warning: You usually won't need to reimplement this method when subclassing from DCategorizedSortFilterProxyModel.

References Digikam::DCategorizedSortFilterProxyModel::Private::categorizedModel, Digikam::DCategorizedSortFilterProxyModel::compareCategories(), and Digikam::DCategorizedSortFilterProxyModel::subSortLessThan().

◆ mapFromDirectSourceToSourceImportModel()

QModelIndex Digikam::ImportSortFilterModel::mapFromDirectSourceToSourceImportModel ( const QModelIndex & sourceModelIndex ) const

inherited

References Digikam::ImportSortFilterModel::m_chainedModel, and Digikam::ImportSortFilterModel::mapToSourceImportModel().

Referenced by Digikam::NoDuplicatesImportFilterModel::filterAcceptsRow().

◆ mapFromSourceImportModel()

QModelIndex Digikam::ImportSortFilterModel::mapFromSourceImportModel ( const QModelIndex & importModelIndex ) const

inherited

References Digikam::ImportSortFilterModel::m_chainedModel, and Digikam::ImportSortFilterModel::mapFromSourceImportModel().

Referenced by Digikam::ImportSortFilterModel::indexForCamItemId(), Digikam::ImportSortFilterModel::indexForCamItemInfo(), Digikam::ImportSortFilterModel::indexForPath(), Digikam::ImportSortFilterModel::mapFromSourceImportModel(), and Digikam::ImportSortFilterModel::mapListFromSource().

◆ mapListFromSource()

QList< QModelIndex > Digikam::ImportSortFilterModel::mapListFromSource ( const QList< QModelIndex > & sourceIndexes ) const

inherited

References Digikam::ImportSortFilterModel::mapFromSourceImportModel().

◆ mapListToSource()

QList< QModelIndex > Digikam::ImportSortFilterModel::mapListToSource ( const QList< QModelIndex > & indexes ) const

inherited

References Digikam::ImportSortFilterModel::mapToSourceImportModel().

Referenced by Digikam::ImportThumbnailBar::assignRating().

◆ mapToSourceImportModel()

QModelIndex Digikam::ImportSortFilterModel::mapToSourceImportModel ( const QModelIndex & proxyIndex ) const

inherited

Convenience methods mapped to ImportItemModel. Mentioned indexes returned come from the source import image model.

References Digikam::ImportSortFilterModel::m_chainedModel, and Digikam::ImportSortFilterModel::mapToSourceImportModel().

Referenced by Digikam::ImportSortFilterModel::camItemId(), Digikam::ImportSortFilterModel::camItemInfo(), Digikam::ImportSortFilterModel::mapFromDirectSourceToSourceImportModel(), Digikam::ImportSortFilterModel::mapListToSource(), and Digikam::ImportSortFilterModel::mapToSourceImportModel().

◆ setCameraThumbsController

void Digikam::ImportFilterModel::setCameraThumbsController ( CameraThumbsCtrl *const thumbsCtrl )

slot

◆ setCamItemSortSettings()

void Digikam::ImportFilterModel::setCamItemSortSettings ( const CamItemSortSettings & sorter )

References Digikam::CamItemSortSettings::NoCategories, and Digikam::DCategorizedSortFilterProxyModel::setCategorizedModel().

Referenced by setCategorizationMode(), setSortOrder(), setSortRole(), and setStringTypeNatural().

◆ setCategorizationMode

void Digikam::ImportFilterModel::setCategorizationMode ( CamItemSortSettings::CategorizationMode mode )

slot

References setCamItemSortSettings().

◆ setCategorizedModel()

void Digikam::DCategorizedSortFilterProxyModel::setCategorizedModel ( bool categorizedModel )

inherited

Enables or disables the categorization feature.

Parameters

categorizedModel whether to enable or disable the categorization feature.

References Digikam::DCategorizedSortFilterProxyModel::Private::categorizedModel.

Referenced by Digikam::CategorizedItemModel::createFilterModel(), Digikam::ActionItemModel::createFilterModel(), setCamItemSortSettings(), Digikam::ItemFilterModel::setItemSortSettings(), and ShowFoto::ShowfotoFilterModel::setShowfotoItemSortSettings().

◆ setDirectSourceImportModel()

void Digikam::ImportFilterModel::setDirectSourceImportModel ( ImportItemModel *const sourceModel )

overrideprotectedvirtual

Reimplement if needed. Called only when model shall be set as (direct) sourceModel.

Reimplemented from Digikam::ImportSortFilterModel.

References Digikam::ImportSortFilterModel::setSourceModel(), and slotProcessAdded().

◆ setFilter

void Digikam::ImportFilterModel::setFilter ( Digikam::Filter * filter )

slot

◆ setSendCamItemInfoSignals()

void Digikam::ImportFilterModel::setSendCamItemInfoSignals ( bool sendSignals )

Enables sending camItemInfosAdded and camItemInfosAboutToBeRemoved.

References slotRowsAboutToBeRemoved(), and slotRowsInserted().

◆ setSortCategoriesByNaturalComparison()

void Digikam::DCategorizedSortFilterProxyModel::setSortCategoriesByNaturalComparison ( bool sortCategoriesByNaturalComparison )

inherited

Set if the sorting using CategorySortRole will use a natural comparison in the case that strings were returned. If enabled, QCollator will be used for sorting.

Parameters

sortCategoriesByNaturalComparison whether to sort using a natural comparison or not.

References Digikam::DCategorizedSortFilterProxyModel::sortCategoriesByNaturalComparison(), and Digikam::DCategorizedSortFilterProxyModel::Private::sortCategoriesByNaturalComparison.