digiKam
Digikam::ImageSortFilterModel Class Reference
+ Inheritance diagram for Digikam::ImageSortFilterModel:

Public Types

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

Public Member Functions

virtual ItemFilterModelimageFilterModel () const
 
qlonglong imageId (const QModelIndex &index) const
 
QList< qlonglong > imageIds (const QList< QModelIndex > &indexes) const
 
ItemInfo imageInfo (const QModelIndex &index) const
 
QList< ItemInfoimageInfos (const QList< QModelIndex > &indexes) const
 
QList< ItemInfoimageInfosSorted () const
 
 ImageSortFilterModel (QObject *const parent=nullptr)
 
QModelIndex indexForImageId (qlonglong id) const
 
QModelIndex indexForItemInfo (const ItemInfo &info) const
 
QModelIndex indexForPath (const QString &filePath) const
 
bool isCategorizedModel () const
 
QModelIndex mapFromDirectSourceToSourceItemModel (const QModelIndex &sourceModel_index) const
 
QModelIndex mapFromSourceItemModel (const QModelIndex &imagemodel_index) const
 
QList< QModelIndex > mapListFromSource (const QList< QModelIndex > &sourceIndexes) const
 
QList< QModelIndex > mapListToSource (const QList< QModelIndex > &indexes) const
 
QModelIndex mapToSourceItemModel (const QModelIndex &index) const
 
void setCategorizedModel (bool categorizedModel)
 
void setSortCategoriesByNaturalComparison (bool sortCategoriesByNaturalComparison)
 
void setSourceFilterModel (ImageSortFilterModel *const model)
 
void setSourceItemModel (ItemModel *const model)
 
void sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
 
bool sortCategoriesByNaturalComparison () const
 
int sortColumn () const
 
Qt::SortOrder sortOrder () const
 
ImageSortFilterModelsourceFilterModel () const
 
ItemModelsourceItemModel () const
 

Protected Member Functions

virtual int compareCategories (const QModelIndex &left, const QModelIndex &right) const
 
bool lessThan (const QModelIndex &left, const QModelIndex &right) const override
 
virtual void setDirectSourceItemModel (ItemModel *const model)
 
void setSourceModel (QAbstractItemModel *const model) override
 NOTE: made protected. More...
 
virtual bool subSortLessThan (const QModelIndex &left, const QModelIndex &right) const
 

Protected Attributes

ImageSortFilterModelm_chainedModel
 

Member Enumeration Documentation

◆ AdditionalRoles

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.

Constructor & Destructor Documentation

◆ ImageSortFilterModel()

Digikam::ImageSortFilterModel::ImageSortFilterModel ( QObject *const  parent = nullptr)
explicit

Member Function Documentation

◆ compareCategories()

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

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 in Digikam::ImportFilterModel, ShowFoto::ShowfotoFilterModel, and Digikam::ItemFilterModel.

References Digikam::DCategorizedSortFilterProxyModel::CategorySortRole, Digikam::DCategorizedSortFilterProxyModel::Private::collator, and Digikam::DCategorizedSortFilterProxyModel::Private::sortCategoriesByNaturalComparison.

Referenced by Digikam::DCategorizedSortFilterProxyModel::lessThan().

◆ imageFilterModel()

ItemFilterModel * Digikam::ImageSortFilterModel::imageFilterModel ( ) const
virtual

Returns this, any chained ItemFilterModel, or 0.

Reimplemented in Digikam::ItemFilterModel.

References imageFilterModel(), and m_chainedModel.

Referenced by imageFilterModel().

◆ imageId()

qlonglong Digikam::ImageSortFilterModel::imageId ( const QModelIndex &  index) const

◆ imageIds()

QList< qlonglong > Digikam::ImageSortFilterModel::imageIds ( const QList< QModelIndex > &  indexes) const

◆ imageInfo()

◆ imageInfos()

QList< ItemInfo > Digikam::ImageSortFilterModel::imageInfos ( const QList< QModelIndex > &  indexes) const

◆ imageInfosSorted()

QList< ItemInfo > Digikam::ImageSortFilterModel::imageInfosSorted ( ) const

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

References Digikam::ItemModel::imageInfo(), mapToSourceItemModel(), and sourceItemModel().

◆ indexForImageId()

QModelIndex Digikam::ImageSortFilterModel::indexForImageId ( qlonglong  id) const

◆ indexForItemInfo()

QModelIndex Digikam::ImageSortFilterModel::indexForItemInfo ( const ItemInfo info) const

◆ indexForPath()

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

◆ isCategorizedModel()

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

◆ mapFromDirectSourceToSourceItemModel()

QModelIndex Digikam::ImageSortFilterModel::mapFromDirectSourceToSourceItemModel ( const QModelIndex &  sourceModel_index) const

◆ mapFromSourceItemModel()

QModelIndex Digikam::ImageSortFilterModel::mapFromSourceItemModel ( const QModelIndex &  imagemodel_index) const

◆ mapListFromSource()

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

◆ mapListToSource()

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

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

References mapToSourceItemModel().

◆ mapToSourceItemModel()

◆ setCategorizedModel()

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

◆ setDirectSourceItemModel()

void Digikam::ImageSortFilterModel::setDirectSourceItemModel ( ItemModel *const  model)
protectedvirtual

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

Reimplemented in Digikam::ItemFilterModel.

References setSourceModel().

Referenced by setSourceItemModel().

◆ 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
sortCategoriesByNaturalComparisonwhether to sort using a natural comparison or not.

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

◆ setSourceFilterModel()

void Digikam::ImageSortFilterModel::setSourceFilterModel ( ImageSortFilterModel *const  model)

◆ setSourceItemModel()

void Digikam::ImageSortFilterModel::setSourceItemModel ( ItemModel *const  model)

◆ setSourceModel()

void Digikam::ImageSortFilterModel::setSourceModel ( QAbstractItemModel *const  model)
overrideprotected

◆ sort()

void Digikam::DCategorizedSortFilterProxyModel::sort ( int  column,
Qt::SortOrder  order = Qt::AscendingOrder 
)
overrideinherited

Overridden from QSortFilterProxyModel. Sorts the source model using column for the given order.

References Digikam::DCategorizedSortFilterProxyModel::Private::sortColumn, and Digikam::DCategorizedSortFilterProxyModel::Private::sortOrder.

◆ sortCategoriesByNaturalComparison()

bool Digikam::DCategorizedSortFilterProxyModel::sortCategoriesByNaturalComparison ( ) const
inherited
Returns
whether it is being used a natural comparison for sorting. Enabled by default.

References Digikam::DCategorizedSortFilterProxyModel::Private::sortCategoriesByNaturalComparison.

Referenced by Digikam::DCategorizedSortFilterProxyModel::setSortCategoriesByNaturalComparison().

◆ sortColumn()

int Digikam::DCategorizedSortFilterProxyModel::sortColumn ( ) const
inherited

◆ sortOrder()

Qt::SortOrder Digikam::DCategorizedSortFilterProxyModel::sortOrder ( ) const
inherited
Returns
the sort order being used for sorting.

References Digikam::DCategorizedSortFilterProxyModel::Private::sortOrder.

◆ sourceFilterModel()

ImageSortFilterModel * Digikam::ImageSortFilterModel::sourceFilterModel ( ) const

References m_chainedModel.

◆ sourceItemModel()

◆ subSortLessThan()

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

This method has a similar purpose as lessThan() has on QSortFilterProxyModel. It is used for sorting items that are in the same category.

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

Reimplemented in Digikam::ImportFilterModel, ShowFoto::ShowfotoFilterModel, and Digikam::ItemFilterModel.

Referenced by Digikam::DCategorizedSortFilterProxyModel::lessThan().

Member Data Documentation

◆ m_chainedModel


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