Fuoten::FolderListFilterModel Class Reference

Proxy filter model for FolderListModel. More...

#include <Fuoten/Models/FolderListFilterModel>

Inheritance diagram for Fuoten::FolderListFilterModel:

Public Member Functions
	FolderListFilterModel (QObject *parent=nullptr)
	Constructs a new folder list filter model with the given parent.
	~FolderListFilterModel () override
	Deconstructs the FeedListModel object.
bool	inOperation () const override
	Returns true while the underlying FolderListModel is loading.
Q_INVOKABLE void	load (const QString &locale=QString()) override
	Loads the data in the underlying FolderListModel.
bool	loaded () const override
	Returns true if the source model has initially loaded its data.
qint64	parentId () const override
	Returns the parent ID that is currently set in the underlying FolderListModel.
Q_INVOKABLE void	reload (const QString &locale=QString()) override
	Reloads the complete underlying FolderListModel.
void	setParentId (qint64 nParentId) override
	Sets the parent ID in the underlying FolderListModel.
void	setStorage (AbstractStorage *nStorage) override
	Sets the pointer to a local storage object in the underlying FolderListModel.
AbstractStorage *	storage () const override
	Returns the pointer to the local storage handler set in the underlying FolderListModel.
Public Member Functions inherited from Fuoten::BaseFilterModel
	BaseFilterModel (QObject *parent=nullptr)
	Constructs a new base filter model with the given parent.
	~BaseFilterModel () override
	Deconstructs the BaseFilterModel object.
double	doubleParentId () const
	Getter function for the doubleParentId property.
bool	hideRead () const
	Returns true if model items with no unread items or unread articles should be hidden.
QString	search () const
	Returns the currently set serach string.
void	setDoubleParentId (double nDoubleParentId)
	Setter function for the doubleParentId property.
void	setHideRead (bool nHideRead)
	Set this to true to hide items with no unread content or read articles.
void	setSearch (const QString &nSearch)
	Sets the search string.
virtual void	setSortingRole (FuotenEnums::SortingRole nSortingRole)
	Sets the sorting role.
virtual void	setSortOrder (Qt::SortOrder nSortOrder)
	Sets the sort order.
virtual FuotenEnums::SortingRole	sortingRole () const
	Returns the currently set sorting role.
virtual Qt::SortOrder	sortOrder () const
	Returns the currently set sort order.

Additional Inherited Members
Properties inherited from Fuoten::BaseFilterModel
double	doubleParentId
	Stores the parent ID as double to make it accesseable from QML.
bool	hideRead
	When true, items with no unread items will be hidden.
bool	inOperation
	Returns true while the underlying BaseModel is initially loading data.
bool	loaded
	This property holds true after the source model has initially loaded its data.
qint64	parentId
	Sets the parentId property of the underlying BaseModel.
QString	search
	Search string to filter the model for.
Fuoten::FuotenEnums::SortingRole	sortingRole
	The property the model items should be sorted by.
Qt::SortOrder	sortOrder
	Defines the sort order.
Fuoten::AbstractStorage *	storage
	Pointer to the AbstractStorage object of the underlying BaseModel.
Signals inherited from Fuoten::BaseFilterModel
void	doubleParentIdChanged (double doubleParentId)
	This signal is emitted if the doubleParentId property changes.
void	hideReadChanged (bool hideRead)
	This signal is emitted if the hideRead property changes.
void	inOperationChanged (bool inOperation)
	This signal is emitted when the operational state of the underlying model changes.
void	loadedChanged (bool loaded)
	This signal is emitted if the loaded property changes.
void	parentIdChanged (qint64 parentId)
	This signal is emitted when the parent ID property changed in the underlying model.
void	searchChanged (const QString &search)
	This signal is emitted if the search string changes.
void	sortingRoleChanged (FuotenEnums::SortingRole sortingRole)
	This signal is emitted if the sorting role changes.
void	sortOrderChanged (Qt::SortOrder sortOrder)
	This signal is emitted if the sort order changes.
void	storageChanged (Fuoten::AbstractStorage *storage)
	This signal is emitted when the pointer to the local storage handler changes in the underlying model.
Protected Member Functions inherited from Fuoten::BaseFilterModel
bool	find (const QString &str) const
	Returns true if the string set by setSearch() is part of str.

Detailed Description

Proxy filter model for FolderListModel.

This proxy model filters and sorts the data of a FolderListModel that is internally created.

Constructor & Destructor Documentation

FolderListFilterModel()

FolderListFilterModel::FolderListFilterModel ( QObject * parent = nullptr )

explicit

Constructs a new folder list filter model with the given parent.

~FolderListFilterModel()

FolderListFilterModel::~FolderListFilterModel ( )

override

Deconstructs the FeedListModel object.

Member Function Documentation

inOperation()

bool FolderListFilterModel::inOperation ( ) const

overridevirtual

Returns true while the underlying FolderListModel is loading.

Implements Fuoten::BaseFilterModel.

load()

void FolderListFilterModel::load ( const QString & locale = QString() )

overridevirtual

Loads the data in the underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

loaded()

bool FolderListFilterModel::loaded ( ) const

overridevirtual

Returns true if the source model has initially loaded its data.

Implements Fuoten::BaseFilterModel.

parentId()

qint64 FolderListFilterModel::parentId ( ) const

overridevirtual

Returns the parent ID that is currently set in the underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

reload()

void FolderListFilterModel::reload ( const QString & locale = QString() )

overridevirtual

Reloads the complete underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

setParentId()

void FolderListFilterModel::setParentId ( qint64 nParentId )

overridevirtual

Sets the parent ID in the underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

setStorage()

void FolderListFilterModel::setStorage ( AbstractStorage * nStorage )

overridevirtual

Sets the pointer to a local storage object in the underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

storage()

AbstractStorage * FolderListFilterModel::storage ( ) const

overridevirtual

Returns the pointer to the local storage handler set in the underlying FolderListModel.

Implements Fuoten::BaseFilterModel.

---

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

• Fuoten/Models/folderlistfiltermodel.h
• Fuoten/Models/folderlistfiltermodel.cpp