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 ()
SearchMessageByButtons::SearchOptions	currentOptions () const
const QString &	filterName () const
void	generateRandomIdentifier ()
const QString &	iconName () const
QString	identifier () const
bool	isEmpty () const
bool	match (const MessageItem *item) const
void	save (const KSharedConfig::Ptr &config, const QString &filtername, const QString &iconName, int numFilter=-1)
QList< SearchLineCommand::SearchLineInfo >	searchLineCommands () const
const QString &	searchString () const
void	setCurrentFolder (const Akonadi::Collection &collection)
void	setFilterName (const QString &newFilterName)
void	setIconName (const QString &newIconName)
void	setIdentifier (const QString &newIdentifier)
void	setOptions (SearchMessageByButtons::SearchOptions newOptions)
void	setSearchString (const QString &search, SearchMessageByButtons::SearchOptions options)
void	setSearchString (const SearchLineCommand &command)
void	setStatus (const QList< Akonadi::MessageStatus > &lstStatus)
void	setTagId (const QString &tagId)
QList< Akonadi::MessageStatus >	status () const
const QString &	tagId () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static Filter *	load (const KSharedConfig::Ptr &config, int filternumber)
static Filter *	loadFromConfigGroup (const KConfigGroup &newGroup)
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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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 const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

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

It's used mainly by Model and Widget.

Definition at line 33 of file filter.h.

Constructor & Destructor Documentation

Filter()

Filter::Filter ( QObject * parent = nullptr )

explicit

Definition at line 22 of file filter.cpp.

Member Function Documentation

clear()

void Filter::clear

(

)

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

Definition at line 140 of file filter.cpp.

currentOptions()

SearchMessageByButtons::SearchOptions Filter::currentOptions ( ) const

nodiscard

Definition at line 292 of file filter.cpp.

filterName()

const QString & Filter::filterName ( ) const

nodiscard

Definition at line 58 of file filter.cpp.

generateRandomIdentifier()

void Filter::generateRandomIdentifier

(

)

Definition at line 615 of file filter.cpp.

iconName()

const QString & Filter::iconName ( ) const

nodiscard

Definition at line 43 of file filter.cpp.

identifier()

QString Filter::identifier ( ) const

nodiscard

Definition at line 620 of file filter.cpp.

isEmpty()

bool Filter::isEmpty ( ) const

nodiscard

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 123 of file filter.cpp.

load()

Filter * Filter::load ( const KSharedConfig::Ptr & config, int filternumber )

staticnodiscard

Definition at line 322 of file filter.cpp.

loadFromConfigGroup()

Filter * Filter::loadFromConfigGroup ( const KConfigGroup & newGroup )

staticnodiscard

Definition at line 333 of file filter.cpp.

match()

bool Filter::match ( const MessageItem * item ) const

nodiscard

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

The msg pointer must not be null.

Definition at line 73 of file filter.cpp.

save()

void Filter::save	(	const KSharedConfig::Ptr &	config,
		const QString &	filtername,
		const QString &	iconName,
		int	numFilter = -1 )

Definition at line 297 of file filter.cpp.

searchLineCommands()

QList< SearchLineCommand::SearchLineInfo > Filter::searchLineCommands ( ) const

nodiscard

Definition at line 154 of file filter.cpp.

searchString()

const QString & Filter::searchString ( ) const

nodiscard

Returns the currently set search string.

Definition at line 287 of file filter.cpp.

setCurrentFolder()

void Filter::setCurrentFolder

(

const Akonadi::Collection &

collection

)

Sets the current folder of this filter.

Definition at line 149 of file filter.cpp.

setFilterName()

void Filter::setFilterName

(

const QString &

newFilterName

)

Definition at line 63 of file filter.cpp.

setIconName()

void Filter::setIconName

(

const QString &

newIconName

)

Definition at line 48 of file filter.cpp.

setIdentifier()

void Filter::setIdentifier

(

const QString &

newIdentifier

)

Definition at line 68 of file filter.cpp.

setOptions()

void Filter::setOptions

(

SearchMessageByButtons::SearchOptions

newOptions

)

Definition at line 53 of file filter.cpp.

setSearchString() [1/2]

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

Sets the search string for this filter.

Definition at line 537 of file filter.cpp.

setSearchString() [2/2]

void Filter::setSearchString

(

const SearchLineCommand &

command

)

Definition at line 355 of file filter.cpp.

setStatus()

void Filter::setStatus

(

const QList< Akonadi::MessageStatus > &

lstStatus

)

Sets the status mask for this filter.

Definition at line 118 of file filter.cpp.

setTagId()

void Filter::setTagId

(

const QString &

tagId

)

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

Definition at line 610 of file filter.cpp.

status()

QList< Akonadi::MessageStatus > Filter::status ( ) const

nodiscard

Returns the currently set status mask.

Definition at line 113 of file filter.cpp.

tagId()

const QString & Filter::tagId ( ) const

nodiscard

Returns the currently set MessageItem::Tag id.

Definition at line 605 of file filter.cpp.

---

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

• filter.h
• filter.cpp