MessageList::Core::Filter
#include <filter.h>

Signals | |
void | finished () |
Public Member Functions | |
Filter (QObject *parent=nullptr) | |
void | addTagId (const QString &tagId) |
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 QStringList &tagId) |
QList< Akonadi::MessageStatus > | status () const |
const QStringList & | tagId () const |
![]() | |
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) |
![]() | |
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 | |
![]() | |
objectName | |
![]() | |
typedef | QObjectList |
![]() | |
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.
Constructor & Destructor Documentation
◆ Filter()
|
explicit |
Definition at line 23 of file filter.cpp.
Member Function Documentation
◆ addTagId()
void Filter::addTagId | ( | const QString & | tagId | ) |
Definition at line 639 of file filter.cpp.
◆ clear()
void Filter::clear | ( | ) |
Clears this filter (sets status to 0, search string and tag id to empty strings)
Definition at line 143 of file filter.cpp.
◆ currentOptions()
|
nodiscard |
Definition at line 307 of file filter.cpp.
◆ filterName()
|
nodiscard |
Definition at line 59 of file filter.cpp.
◆ generateRandomIdentifier()
void Filter::generateRandomIdentifier | ( | ) |
Definition at line 644 of file filter.cpp.
◆ iconName()
|
nodiscard |
Definition at line 44 of file filter.cpp.
◆ identifier()
|
nodiscard |
Definition at line 649 of file filter.cpp.
◆ isEmpty()
|
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 126 of file filter.cpp.
◆ load()
|
staticnodiscard |
Definition at line 337 of file filter.cpp.
◆ loadFromConfigGroup()
|
staticnodiscard |
Definition at line 348 of file filter.cpp.
◆ match()
|
nodiscard |
Returns true if the specified parameters match this filter and false otherwise.
The msg pointer must not be null.
Definition at line 74 of file filter.cpp.
◆ save()
void Filter::save | ( | const KSharedConfig::Ptr & | config, |
const QString & | filtername, | ||
const QString & | iconName, | ||
int | numFilter = -1 ) |
Definition at line 312 of file filter.cpp.
◆ searchLineCommands()
|
nodiscard |
Definition at line 157 of file filter.cpp.
◆ searchString()
|
nodiscard |
Returns the currently set search string.
Definition at line 302 of file filter.cpp.
◆ setCurrentFolder()
void Filter::setCurrentFolder | ( | const Akonadi::Collection & | collection | ) |
Sets the current folder of this filter.
Definition at line 152 of file filter.cpp.
◆ setFilterName()
void Filter::setFilterName | ( | const QString & | newFilterName | ) |
Definition at line 64 of file filter.cpp.
◆ setIconName()
void Filter::setIconName | ( | const QString & | newIconName | ) |
Definition at line 49 of file filter.cpp.
◆ setIdentifier()
void Filter::setIdentifier | ( | const QString & | newIdentifier | ) |
Definition at line 69 of file filter.cpp.
◆ setOptions()
void Filter::setOptions | ( | SearchMessageByButtons::SearchOptions | newOptions | ) |
Definition at line 54 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 561 of file filter.cpp.
◆ setSearchString() [2/2]
void Filter::setSearchString | ( | const SearchLineCommand & | command | ) |
Definition at line 370 of file filter.cpp.
◆ setStatus()
void Filter::setStatus | ( | const QList< Akonadi::MessageStatus > & | lstStatus | ) |
Sets the status mask for this filter.
Definition at line 121 of file filter.cpp.
◆ setTagId()
void Filter::setTagId | ( | const QStringList & | tagId | ) |
Sets the id of a MessageItem::Tag that the matching messages must contain.
Definition at line 634 of file filter.cpp.
◆ status()
|
nodiscard |
Returns the currently set status mask.
Definition at line 116 of file filter.cpp.
◆ tagId()
|
nodiscard |
Returns the currently set MessageItem::Tag id.
Definition at line 629 of file filter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:51:55 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.