Inheritance diagram for Digikam::AlbumFilterModel:

Public Types
enum	FilterBehavior { SimpleFiltering , FullFiltering , StrictFiltering }

enum	MatchResult { NoMatch = 0 , DirectMatch , ParentMatch , ChildMatch , SpecialMatch }

Public Slots
void	setSearchTextSettings (const SearchTextSettings &settings)

Signals
void	hasSearchResult (bool hasResult)

void	searchTextSettingsAboutToChange (bool searched, bool willSearch)

void	searchTextSettingsChanged (bool wasSearching, bool searched)

void	signalFilterChanged ()

Public Member Functions
	AlbumFilterModel (QObject *const parent=nullptr)

Album *	albumForIndex (const QModelIndex &index) const
	Convenience methods. More...

QVariant	dataForCurrentSortRole (Album *album) const

QModelIndex	indexForAlbum (Album *album) const

virtual bool	isFiltering () const

QModelIndex	mapFromSourceAlbumModel (const QModelIndex &index) const

QModelIndex	mapToSourceAlbumModel (const QModelIndex &index) const

MatchResult	matchResult (const QModelIndex &index) const

QModelIndex	rootAlbumIndex () const

SearchTextSettings	searchTextSettings () const

void	setFilterBehavior (FilterBehavior behavior)

void	setSourceAlbumModel (AbstractAlbumModel *const source)

void	setSourceFilterModel (AlbumFilterModel *const source)

AbstractAlbumModel *	sourceAlbumModel () const

AlbumFilterModel *	sourceFilterModel () const

void	updateFilter ()

Static Public Member Functions
template<typename T >
static int	compareByOrder (const T &a, const T &b, Qt::SortOrder sortOrder)

static int	compareByOrder (int compareResult, Qt::SortOrder sortOrder)

template<typename T >
static int	compareValue (const T &a, const T &b)

Protected Slots
void	slotAlbumRenamed (Album *album)

void	slotAlbumsHaveBeenUpdated (int type)

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

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

virtual bool	matches (Album *album) const

MatchResult	matchResult (Album *album) const

void	setSourceModel (QAbstractItemModel *const model) override

Protected Attributes
QPointer< AlbumFilterModel >	m_chainedModel

FilterBehavior	m_filterBehavior

QObject *	m_parent

SearchTextSettings	m_settings

Member Enumeration Documentation

◆ FilterBehavior

enum Digikam::AlbumFilterModel::FilterBehavior

Enumerator
SimpleFiltering	If an index does not matched, the index and all its children are filtered out. This is the Qt default behavior, but undesirable for album trees.
FullFiltering	Default behavior. If an index matches, it is shown, which directly means all its parents are shown as well. In addition, all its children are shown as well.
StrictFiltering	If an index matches, it is shown, which directly means all its parents are shown as well. Its children are not shown unless they also match.

◆ MatchResult

enum Digikam::AlbumFilterModel::MatchResult

Enumerator
NoMatch	This enum can be used as a boolean value if match/no match only is needed.
DirectMatch	The index itself is matched.
ParentMatch	A parent if the index is matched.
ChildMatch	A child of the index is matched.
SpecialMatch	The index is matched not because of search settings, but because it has a special type.

Constructor & Destructor Documentation

◆ AlbumFilterModel()

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

explicit

References Digikam::AbstractAlbumModel::AlbumSortRole, Digikam::AlbumManager::instance(), Digikam::ApplicationSettings::instance(), slotAlbumRenamed(), and slotAlbumsHaveBeenUpdated().

Member Function Documentation

◆ albumForIndex()

Album * Digikam::AlbumFilterModel::albumForIndex ( const QModelIndex & index ) const

Convenience methods.

References Digikam::AbstractAlbumModel::retrieveAlbum().

Referenced by Digikam::AlbumTreeView::albumForIndex(), Digikam::DateTreeView::albumForIndex(), Digikam::TagTreeView::albumForIndex(), Digikam::TagFolderView::contextMenuEvent(), Digikam::AlbumTreeView::currentAlbum(), Digikam::DateTreeView::currentAlbum(), Digikam::SearchTreeView::currentAlbum(), Digikam::TagTreeView::currentAlbum(), Digikam::AbstractAlbumTreeView::doSaveState(), lessThan(), matchResult(), Digikam::AbstractAlbumTreeView::mousePressEvent(), and Digikam::AbstractAlbumTreeView::slotCurrentChanged().

◆ compareByOrder() [1/2]

template<typename T >

static int Digikam::AlbumFilterModel::compareByOrder	(	const T &	a,
		const T &	b,
		Qt::SortOrder	sortOrder
	)

inlinestatic

◆ compareByOrder() [2/2]

static int Digikam::AlbumFilterModel::compareByOrder	(	int	compareResult,
		Qt::SortOrder	sortOrder
	)

inlinestatic

Takes a typical result from a compare method (0 is equal, -1 is less than, 1 is greater than) and applies the given sort order to it.

Referenced by lessThan().

◆ compareValue()

template<typename T >

static int Digikam::AlbumFilterModel::compareValue	(	const T &	a,
		const T &	b
	)

inlinestatic

Returns the usual compare result of -1, 0, or 1 for lessThan, equals and greaterThan.

◆ dataForCurrentSortRole()

QVariant Digikam::AlbumFilterModel::dataForCurrentSortRole ( Album * album ) const

References Digikam::ApplicationSettings::ByDate, Digikam::ApplicationSettings::ByFolder, Digikam::PAlbum::category(), Digikam::Album::DATE, Digikam::PAlbum::date(), Digikam::ApplicationSettings::getAlbumSortRole(), Digikam::ApplicationSettings::instance(), Digikam::Album::PHYSICAL, Digikam::Album::SEARCH, Digikam::Album::TAG, Digikam::Album::title(), and Digikam::Album::type().

Referenced by lessThan().

◆ filterAcceptsRow()

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

overrideprotected

References matchResult(), and Digikam::AbstractAlbumModel::retrieveAlbum().

◆ hasSearchResult

void Digikam::AlbumFilterModel::hasSearchResult ( bool hasResult )

signal

Indicates whether the newly applied filter results in a search result or not.

Parameters

hasResult true if the new filter matches any album, else false

Referenced by setSearchTextSettings().

◆ indexForAlbum()

QModelIndex Digikam::AlbumFilterModel::indexForAlbum ( Album * album ) const

References Digikam::AbstractAlbumModel::indexForAlbum(), mapFromSourceAlbumModel(), and sourceAlbumModel().

Referenced by Digikam::AbstractAlbumTreeView::slotSearchTextSettingsChanged().

◆ isFiltering()

bool Digikam::AlbumFilterModel::isFiltering ( ) const

virtual

Returns if the currently applied filters will result in any filtering.

Returns: true if the current selected filter could result in any filtering without checking if this really happens.

Reimplemented in Digikam::TagPropertiesFilterModel, Digikam::SearchFilterModel, and Digikam::CheckableAlbumFilterModel.

References m_settings.

Referenced by Digikam::CheckableAlbumFilterModel::isFiltering(), and updateFilter().

◆ lessThan()

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

overrideprotected

Implementation to sort Tags that contain Unconfirmed Faces, according to the Unconfirmed Face Count.

References Digikam::ItemSortCollator::albumCompare(), albumForIndex(), Digikam::ApplicationSettings::ByCategory, Digikam::ApplicationSettings::ByDate, compareByOrder(), dataForCurrentSortRole(), Digikam::ApplicationSettings::getAlbumSortRole(), Digikam::AlbumManager::getUnconfirmedFaceCount(), Digikam::Album::id(), Digikam::FaceTags::ignoredPersonTagId(), Digikam::AlbumManager::instance(), Digikam::ItemSortCollator::instance(), Digikam::ApplicationSettings::instance(), Digikam::AbstractAlbumModel::isFaceTagModel(), Digikam::ApplicationSettings::isStringTypeNatural(), Digikam::Album::isTrashAlbum(), sourceAlbumModel(), Digikam::Album::TAG, Digikam::Album::type(), Digikam::FaceTags::unconfirmedPersonTagId(), and Digikam::FaceTags::unknownPersonTagId().

◆ mapFromSourceAlbumModel()

QModelIndex Digikam::AlbumFilterModel::mapFromSourceAlbumModel ( const QModelIndex & index ) const

References m_chainedModel.

Referenced by indexForAlbum(), and rootAlbumIndex().

◆ mapToSourceAlbumModel()

QModelIndex Digikam::AlbumFilterModel::mapToSourceAlbumModel ( const QModelIndex & index ) const

References m_chainedModel.

Referenced by Digikam::AbstractAlbumTreeView::dragMoveEvent(), and Digikam::AbstractAlbumTreeView::dropEvent().

◆ matches()

bool Digikam::AlbumFilterModel::matches ( Album * album ) const

protectedvirtual

This method provides the basic match checking algorithm. Return true if this single album matches the current criteria. This method can be overridden to provide custom filtering.

Parameters

album the album to tell if it matches the filter criteria or not.

Reimplemented in Digikam::TagsManagerFilterModel, Digikam::TagPropertiesFilterModel, Digikam::SearchFilterModel, and Digikam::CheckableAlbumFilterModel.

References Digikam::AbstractAlbumModel::AlbumTitleRole, Digikam::SearchTextSettings::caseSensitive, Digikam::AbstractAlbumModel::indexForAlbum(), m_chainedModel, m_settings, sourceAlbumModel(), and Digikam::SearchTextSettings::text.

Referenced by Digikam::CheckableAlbumFilterModel::matches(), and matchResult().

◆ matchResult() [1/2]

AlbumFilterModel::MatchResult Digikam::AlbumFilterModel::matchResult ( Album * album ) const

protected

Returns if the filter matches this album (same logic as filterAcceptsRow). An album matches if the search text settings are found in a parent album's title, in the album's title or in a child album's title, or if it is a special album (root) that is never filtered out.

References ChildMatch, Digikam::AlbumIterator::current(), DirectMatch, FullFiltering, Digikam::PAlbum::isAlbumRoot(), Digikam::TAlbum::isInternalTag(), Digikam::Album::isRoot(), m_filterBehavior, matches(), NoMatch, Digikam::Album::parent(), ParentMatch, SimpleFiltering, and SpecialMatch.

◆ matchResult() [2/2]

AlbumFilterModel::MatchResult Digikam::AlbumFilterModel::matchResult ( const QModelIndex & index ) const

Returns the MatchResult of an index of this model. Never returns NoMatch for a valid index, because in this case, the index would rather be filtered out.

References albumForIndex().

Referenced by Digikam::AbstractAlbumTreeView::expandMatches(), and filterAcceptsRow().

◆ rootAlbumIndex()

QModelIndex Digikam::AlbumFilterModel::rootAlbumIndex ( ) const

References mapFromSourceAlbumModel(), Digikam::AbstractAlbumModel::rootAlbumIndex(), and sourceAlbumModel().

Referenced by Digikam::AbstractAlbumTreeView::setAlbumFilterModel(), Digikam::AbstractAlbumTreeView::setAlbumModel(), Digikam::TagTreeView::setAlbumModel(), setSearchTextSettings(), Digikam::AbstractAlbumTreeView::slotCollapseAllNodes(), and Digikam::AbstractAlbumTreeView::slotRootAlbumAvailable().

◆ searchTextSettings()

SearchTextSettings Digikam::AlbumFilterModel::searchTextSettings ( ) const

Returns the settings currently used for filtering.

Returns: current settings for filtering.

References m_settings.

◆ searchTextSettingsAboutToChange

void Digikam::AlbumFilterModel::searchTextSettingsAboutToChange	(	bool	searched,
		bool	willSearch
	)

signal

This signal indicates that a new SearchTextSettings arrived and is about to be applied to the model.

Parameters

searched	`true` if filtering by text was enabled before applying the new settings
willSearch	`true` if the new settings can result in any filtering by text, else `false`.

Referenced by setSearchTextSettings().

◆ searchTextSettingsChanged

void Digikam::AlbumFilterModel::searchTextSettingsChanged	(	bool	wasSearching,
		bool	searched
	)

signal

Indicates that new search text settings were applied.

Parameters

wasSearching	`true` if this is not a new search that
searched	`true` if the new settings result in any filtering

Referenced by setSearchTextSettings().

◆ setFilterBehavior()

void Digikam::AlbumFilterModel::setFilterBehavior ( FilterBehavior behavior )

Sets the filter behavior. Default is FullFiltering.

References m_filterBehavior.

◆ setSearchTextSettings

void Digikam::AlbumFilterModel::setSearchTextSettings ( const SearchTextSettings & settings )

slot

Accepts new settings used for filtering and applies them to the model.

Parameters

settings new settings to apply. An empty text will be interpreted as no filtering

References hasSearchResult(), m_settings, Digikam::Album::PHYSICAL, rootAlbumIndex(), searchTextSettingsAboutToChange(), searchTextSettingsChanged(), signalFilterChanged(), sourceAlbumModel(), and Digikam::SearchTextSettings::text.

Referenced by Digikam::AbstractAlbumTreeView::setSearchTextSettings().

◆ setSourceAlbumModel()

void Digikam::AlbumFilterModel::setSourceAlbumModel ( AbstractAlbumModel *const source )

Sets the source model. Note: If a chained filter model is set, it will not be reset, but the source album model will be made source of the chained filter model.

References m_chainedModel, and setSourceModel().

Referenced by Digikam::AbstractAlbumTreeView::setAlbumFilterModel(), Digikam::AbstractAlbumTreeView::setAlbumModel(), Digikam::SearchFilterModel::setSourceAlbumModel(), Digikam::CheckableAlbumFilterModel::setSourceAlbumModel(), and setSourceFilterModel().

◆ setSourceFilterModel()

void Digikam::AlbumFilterModel::setSourceFilterModel ( AlbumFilterModel *const source )

Sets a chained filter model. Note: If a direct source album model is set as current source, it will be set as sourceAlbumModel of the new source filter model.

References m_chainedModel, setSourceAlbumModel(), setSourceModel(), and sourceAlbumModel().

Referenced by Digikam::CheckableAlbumFilterModel::setSourceFilterModel().