digiKam
ShowFoto::ShowfotoFilterModel Class Reference
+ Inheritance diagram for ShowFoto::ShowfotoFilterModel:

Public Types

enum  AdditionalRoles { CategoryDisplayRole = 0x17CE990A , CategorySortRole = 0x27857E60 }
 
enum  ShowfotoFilterModelRoles { CategorizationModeRole = ShowfotoItemModel::FilterModelRoles + 1 , SortOrderRole = ShowfotoItemModel::FilterModelRoles + 2 , CategoryFormatRole = ShowfotoItemModel::FilterModelRoles + 3 , ShowfotoFilterModelPointerRole = ShowfotoItemModel::FilterModelRoles + 50 }
 

Public Slots

void setCategorizationMode (ShowfotoItemSortSettings::CategorizationMode mode)
 
void setSortOrder (ShowfotoItemSortSettings::SortOrder order)
 
void setSortRole (ShowfotoItemSortSettings::SortRole role)
 

Signals

void showfotoItemInfosAboutToBeRemoved (const QList< ShowfotoItemInfo > &infos)
 
void showfotoItemInfosAdded (const QList< ShowfotoItemInfo > &infos)
 

Public Member Functions

QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
 
QModelIndex indexForShowfotoItemId (qlonglong id) const
 
QModelIndex indexForShowfotoItemInfo (const ShowfotoItemInfo &info) const
 
QModelIndex indexForUrl (const QUrl &fileUrl) const
 
bool isCategorizedModel () const
 
QModelIndex mapFromDirectSourceToSourceShowfotoModel (const QModelIndex &sourceModelIndex) const
 
QModelIndex mapFromSourceShowfotoModel (const QModelIndex &showfotoModelIndex) const
 
QList< QModelIndex > mapListFromSource (const QList< QModelIndex > &sourceIndexes) const
 
QList< QModelIndex > mapListToSource (const QList< QModelIndex > &indexes) const
 
QModelIndex mapToSourceShowfotoModel (const QModelIndex &proxyIndex) const
 
void setCategorizedModel (bool categorizedModel)
 
void setSendShowfotoItemInfoSignals (bool sendSignals)
 Enables sending ShowfotoItemInfosAdded and ShowfotoItemInfosAboutToBeRemoved. More...
 
void setShowfotoItemSortSettings (const ShowfotoItemSortSettings &sorter)
 
void setSortCategoriesByNaturalComparison (bool sortCategoriesByNaturalComparison)
 
void setSourceFilterModel (ShowfotoSortFilterModel *const sourceModel)
 
void setSourceShowfotoModel (ShowfotoItemModel *const sourceModel)
 
ShowfotoFilterModelshowfotoFilterModel () const override
 Returns this, any chained ShowfotoFilterModel, or 0. More...
 
 ShowfotoFilterModel (QObject *const parent=nullptr)
 
qlonglong showfotoItemId (const QModelIndex &index) const
 
QList< qlonglong > showfotoItemIds (const QList< QModelIndex > &indexes) const
 
ShowfotoItemInfo showfotoItemInfo (const QModelIndex &index) const
 
QList< ShowfotoItemInfoshowfotoItemInfos (const QList< QModelIndex > &indexes) const
 
QList< ShowfotoItemInfoshowfotoItemInfosSorted () const
 
ShowfotoItemSortSettings showfotoItemSortSettings () const
 
void sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
 
bool sortCategoriesByNaturalComparison () const
 
int sortColumn () const
 
Qt::SortOrder sortOrder () const
 
ShowfotoSortFilterModelsourceFilterModel () const
 
ShowfotoItemModelsourceShowfotoModel () const
 
 ~ShowfotoFilterModel () override
 

Protected Slots

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 ShowfotoItemInfo &info) const
 
int compareCategories (const QModelIndex &left, const QModelIndex &right) const override
 
virtual int compareInfosCategories (const ShowfotoItemInfo &left, const ShowfotoItemInfo &right) const
 
virtual bool infosLessThan (const ShowfotoItemInfo &left, const ShowfotoItemInfo &right) const
 
bool lessThan (const QModelIndex &left, const QModelIndex &right) const override
 
void setDirectSourceShowfotoModel (ShowfotoItemModel *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

ShowfotoFilterModelPrivate *const d_ptr
 
ShowfotoSortFilterModelm_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.

◆ ShowfotoFilterModelRoles

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.

ShowfotoFilterModelPointerRole 

Returns true if the given showfoto item is a group leader, and the group is opened. TODO: GroupIsOpenRole = ShowfotoItemModel::FilterModelRoles + 4

Constructor & Destructor Documentation

◆ ShowfotoFilterModel()

ShowFoto::ShowfotoFilterModel::ShowfotoFilterModel ( QObject *const  parent = nullptr)
explicit

References d_ptr.

◆ ~ShowfotoFilterModel()

ShowFoto::ShowfotoFilterModel::~ShowfotoFilterModel ( )
override

Member Function Documentation

◆ categoryIdentifier()

QString ShowFoto::ShowfotoFilterModel::categoryIdentifier ( const ShowfotoItemInfo info) const
protectedvirtual

◆ compareCategories()

int ShowFoto::ShowfotoFilterModel::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 ShowFoto::ShowfotoFilterModel::compareInfosCategories ( const ShowfotoItemInfo left,
const ShowfotoItemInfo 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 ShowFoto::ShowfotoFilterModel::data ( const QModelIndex &  index,
int  role = Qt::DisplayRole 
) const
override

◆ indexForShowfotoItemId()

QModelIndex ShowFoto::ShowfotoSortFilterModel::indexForShowfotoItemId ( qlonglong  id) const
inherited

◆ indexForShowfotoItemInfo()

QModelIndex ShowFoto::ShowfotoSortFilterModel::indexForShowfotoItemInfo ( const ShowfotoItemInfo info) const
inherited

◆ indexForUrl()

QModelIndex ShowFoto::ShowfotoSortFilterModel::indexForUrl ( const QUrl &  fileUrl) const
inherited

◆ infosLessThan()

bool ShowFoto::ShowfotoFilterModel::infosLessThan ( const ShowfotoItemInfo left,
const ShowfotoItemInfo right 
) const
protectedvirtual

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

Referenced by subSortLessThan().

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

◆ mapFromDirectSourceToSourceShowfotoModel()

QModelIndex ShowFoto::ShowfotoSortFilterModel::mapFromDirectSourceToSourceShowfotoModel ( const QModelIndex &  sourceModelIndex) const
inherited

◆ mapFromSourceShowfotoModel()

◆ mapListFromSource()

QList< QModelIndex > ShowFoto::ShowfotoSortFilterModel::mapListFromSource ( const QList< QModelIndex > &  sourceIndexes) const
inherited

◆ mapListToSource()

QList< QModelIndex > ShowFoto::ShowfotoSortFilterModel::mapListToSource ( const QList< QModelIndex > &  indexes) const
inherited

◆ mapToSourceShowfotoModel()

QModelIndex ShowFoto::ShowfotoSortFilterModel::mapToSourceShowfotoModel ( const QModelIndex &  proxyIndex) const
inherited

◆ setCategorizationMode

void ShowFoto::ShowfotoFilterModel::setCategorizationMode ( ShowfotoItemSortSettings::CategorizationMode  mode)
slot

◆ setCategorizedModel()

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

◆ setDirectSourceShowfotoModel()

void ShowFoto::ShowfotoFilterModel::setDirectSourceShowfotoModel ( ShowfotoItemModel *const  sourceModel)
overrideprotectedvirtual

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

Reimplemented from ShowFoto::ShowfotoSortFilterModel.

References ShowFoto::ShowfotoSortFilterModel::setSourceModel().

◆ setSendShowfotoItemInfoSignals()

void ShowFoto::ShowfotoFilterModel::setSendShowfotoItemInfoSignals ( bool  sendSignals)

Enables sending ShowfotoItemInfosAdded and ShowfotoItemInfosAboutToBeRemoved.

References slotRowsAboutToBeRemoved(), and slotRowsInserted().

◆ setShowfotoItemSortSettings()

void ShowFoto::ShowfotoFilterModel::setShowfotoItemSortSettings ( const ShowfotoItemSortSettings sorter)

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

◆ setSortOrder

void ShowFoto::ShowfotoFilterModel::setSortOrder ( ShowfotoItemSortSettings::SortOrder  order)
slot

◆ setSortRole

void ShowFoto::ShowfotoFilterModel::setSortRole ( ShowfotoItemSortSettings::SortRole  role)
slot

◆ setSourceFilterModel()

◆ setSourceModel()

void ShowFoto::ShowfotoSortFilterModel::setSourceModel ( QAbstractItemModel *  sourceModel)
overrideprotectedinherited

◆ setSourceShowfotoModel()

◆ showfotoFilterModel()

ShowfotoFilterModel * ShowFoto::ShowfotoFilterModel::showfotoFilterModel ( ) const
overridevirtual

Returns this, any chained ShowfotoFilterModel, or 0.

Reimplemented from ShowFoto::ShowfotoSortFilterModel.

◆ showfotoItemId()

qlonglong ShowFoto::ShowfotoSortFilterModel::showfotoItemId ( const QModelIndex &  index) const
inherited

◆ showfotoItemIds()

QList<qlonglong> ShowFoto::ShowfotoSortFilterModel::showfotoItemIds ( const QList< QModelIndex > &  indexes) const
inherited

◆ showfotoItemInfo()

◆ showfotoItemInfos()

QList< ShowfotoItemInfo > ShowFoto::ShowfotoSortFilterModel::showfotoItemInfos ( const QList< QModelIndex > &  indexes) const
inherited

◆ showfotoItemInfosAboutToBeRemoved

void ShowFoto::ShowfotoFilterModel::showfotoItemInfosAboutToBeRemoved ( const QList< ShowfotoItemInfo > &  infos)
signal

◆ showfotoItemInfosAdded

void ShowFoto::ShowfotoFilterModel::showfotoItemInfosAdded ( const QList< ShowfotoItemInfo > &  infos)
signal

These signals need to be explicitly enabled with setSendItemInfoSignals().

Referenced by slotRowsInserted().

◆ showfotoItemInfosSorted()

QList< ShowfotoItemInfo > ShowFoto::ShowfotoSortFilterModel::showfotoItemInfosSorted ( ) const
inherited

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

References ShowFoto::ShowfotoSortFilterModel::showfotoItemInfo().

◆ showfotoItemSortSettings()

ShowfotoItemSortSettings ShowFoto::ShowfotoFilterModel::showfotoItemSortSettings ( ) const

◆ slotRowsAboutToBeRemoved

void ShowFoto::ShowfotoFilterModel::slotRowsAboutToBeRemoved ( const QModelIndex &  parent,
int  start,
int  end 
)
protectedslot

◆ slotRowsInserted

void ShowFoto::ShowfotoFilterModel::slotRowsInserted ( const QModelIndex &  parent,
int  start,
int  end 
)
protectedslot

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

ShowfotoSortFilterModel * ShowFoto::ShowfotoSortFilterModel::sourceFilterModel ( ) const
inherited

◆ sourceShowfotoModel()

◆ subSortLessThan()

bool ShowFoto::ShowfotoFilterModel::subSortLessThan ( const QModelIndex &  left,
const QModelIndex &  right 
) const
overrideprotectedvirtual

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

References ShowFoto::ShowfotoItemModel::ExtraDataRole, and infosLessThan().

Member Data Documentation

◆ d_ptr

ShowfotoFilterModelPrivate* const ShowFoto::ShowfotoFilterModel::d_ptr
protected

Referenced by ShowfotoFilterModel().

◆ m_chainedModel


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