MessageList::Core::Filter Class Reference

#include <filter.h>

Inheritance diagram for MessageList::Core::Filter:

Signals
void	finished ()

Public Member Functions
	Filter (QObject *parent=nullptr)
void	clear ()
QuickSearchLine::SearchOptions	currentOptions () const
bool	isEmpty () const
bool	match (const MessageItem *item) const
const QString &	searchString () const
void	setCurrentFolder (const Akonadi::Collection &collection)
void	setSearchString (const QString &search, QuickSearchLine::SearchOptions options)
void	setStatus (const QVector< Akonadi::MessageStatus > &lstStatus)
void	setTagId (const QString &tagId)
QVector< Akonadi::MessageStatus >	status () const
const QString &	tagId () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

This class is responsable of matching messages that should be displayed in the View.

It's used mainly by Model and Widget.

Definition at line 40 of file filter.h.

Member Function Documentation

void Filter::clear

(

)

Clears this filter (sets status to 0, search string and tag id to empty strings)

Definition at line 105 of file filter.cpp.

bool Filter::isEmpty

(

)

const

Returns true if this filter is empty (0 status mask, empty search string and empty tag) and it's useless to call match() that will always return true.

Definition at line 88 of file filter.cpp.

bool Filter::match

(

const MessageItem *

item

)

const

Returns true if the specified parameters match this filter and false otherwise.

The msg pointer must not be null.

Definition at line 48 of file filter.cpp.

const QString& MessageList::Core::Filter::searchString ( ) const

inline

Returns the currently set search string.

Definition at line 78 of file filter.h.

void Filter::setCurrentFolder

(

const Akonadi::Collection &

collection

)

Sets the current folder of this filter.

Definition at line 114 of file filter.cpp.

void Filter::setSearchString	(	const QString &	search,
		QuickSearchLine::SearchOptions	options
	)

Sets the search string for this filter.

Definition at line 124 of file filter.cpp.

void MessageList::Core::Filter::setStatus ( const QVector< Akonadi::MessageStatus > &  lstStatus )

inline

Sets the status mask for this filter.

Definition at line 65 of file filter.h.

void MessageList::Core::Filter::setTagId ( const QString &  tagId )

inline

Sets the id of a MessageItem::Tag that the matching messages must contain.

Definition at line 99 of file filter.h.

QVector<Akonadi::MessageStatus> MessageList::Core::Filter::status ( ) const

inline

Returns the currently set status mask.

Definition at line 57 of file filter.h.

const QString& MessageList::Core::Filter::tagId ( ) const

inline

Returns the currently set MessageItem::Tag id.

Definition at line 91 of file filter.h.

---

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

• filter.h
• filter.cpp