LC::Util::TagsFilterModel Class Reference

Provides filter model with additional tags filter mode. More...

#include "tagsfiltermodel.h"

Inheritance diagram for LC::Util::TagsFilterModel:

Collaboration diagram for LC::Util::TagsFilterModel:

Public Types
enum	TagsInclusionMode {   TagsInclusionMode::Any,   TagsInclusionMode::All }
	Describes the modes of matching two sets of tags. More...

Public Member Functions
	TagsFilterModel (QObject *parent=nullptr)
	Creates the model with the given parent. More...
void	SetSeparator (const QString &separator)
	Sets the separator for the tags. More...
void	SetTagsInclusionMode (TagsInclusionMode mode)
	Sets the tags inclusion mode. More...
void	SetTagsMode (bool enabled)
	Sets whether the tags filtering mode is enabled. More...

Protected Member Functions
bool	filterAcceptsRow (int, const QModelIndex &) const override
	Reimplemented from QSortFilterProxyModel::filterAcceptsRow(). More...
virtual QStringList	GetTagsForIndex (int row) const =0
	Returns the list of tags for the given row. More...

Detailed Description

Provides filter model with additional tags filter mode.

This model behaves just like a normal QSortFilterProxyModel except it supports filtering by tags. In this mode row is accepted either if all tags from the request are found in the row (the default mode) or if the intersection of the two sets is just non-empty. The mode can be set via SetTagsInclusionMode() function. The tags filtering mode itself is enabled via SetTagsMode() function.

The tags are obtained by splitting the filter pattern by the separator, which is ; by default but can be set via the SetSeparator() method.

Definition at line 35 of file tagsfiltermodel.h.

Member Enumeration Documentation

TagsInclusionMode

enum LC::Util::TagsFilterModel::TagsInclusionMode

strong

Describes the modes of matching two sets of tags.

See also

SetTagsInclusionMode()

Enumerator
Any	Tags intersection should be non-empty. In other words, at least one tag from the filter string should be found in the list of tags of a row.
All	Filter string tags should be a subset of row tags. In other words, all of the tags from the filter string should be found in the list of tags of a row.

Definition at line 50 of file tagsfiltermodel.h.

Constructor & Destructor Documentation

TagsFilterModel()

LC::Util::TagsFilterModel::TagsFilterModel ( QObject *  parent = nullptr )

explicit

Creates the model with the given parent.

Parameters

[in]

parent

The parent object of this model.

Definition at line 23 of file tagsfiltermodel.cpp.

Member Function Documentation

filterAcceptsRow()

bool LC::Util::TagsFilterModel::filterAcceptsRow ( int  sourceRow, const QModelIndex &  index  ) const

overrideprotected

Reimplemented from QSortFilterProxyModel::filterAcceptsRow().

Definition at line 53 of file tagsfiltermodel.cpp.

GetTagsForIndex()

virtual QStringList LC::Util::TagsFilterModel::GetTagsForIndex ( int  row ) const

protectedpure virtual

Returns the list of tags for the given row.

This function should return the list of tags for the given row. Reimplement it in your subclass to provide this filter model with correct tags for rows.

Parameters

[in]

row

The source row for which tags should be fetched.

Returns

The list of tags for the row.

SetSeparator()

void LC::Util::TagsFilterModel::SetSeparator

(

const QString &

separator

)

Sets the separator for the tags.

The separator is used to split the regexp filter string (the one set via setFilterFixedString() method) into the list of tags.

Setting this property will invalidate the model if the dynamicSortFilter() property is true.

Parameters

[in]

separator

The separator string.

See also

GetDefaultTagsSeparator()

Definition at line 29 of file tagsfiltermodel.cpp.

SetTagsInclusionMode()

void LC::Util::TagsFilterModel::SetTagsInclusionMode

(

TagsFilterModel::TagsInclusionMode

mode

)

Sets the tags inclusion mode.

Setting this property will invalidate the model if the dynamicSortFilter() property is true.

Parameters

[in]

mode

The tags inclusion mode.

Definition at line 37 of file tagsfiltermodel.cpp.

SetTagsMode()

void LC::Util::TagsFilterModel::SetTagsMode

(

bool

enabled

)

Sets whether the tags filtering mode is enabled.

By default the tags mode is disabled.

Parameters

[in]

enabled

Whether the tags mode should be enabled.

Definition at line 45 of file tagsfiltermodel.cpp.

---

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

• /home/d34df00d/leechcraft/src/util/tags/tagsfiltermodel.h
• /home/d34df00d/leechcraft/src/util/tags/tagsfiltermodel.cpp