MailCommon::FilterLog

Search for usage in LXR

#include <filterlog.h>

Inheritance diagram for MailCommon::FilterLog:

Public Types

enum  ContentType {
  Meta = 1, PatternDescription = 2, RuleResult = 4, PatternResult = 8,
  AppliedAction = 16
}
 

Signals

void logEntryAdded (const QString &entry)
 
void logShrinked ()
 
void logStateChanged ()
 

Public Member Functions

 ~FilterLog () override
 
void add (const QString &entry, ContentType type)
 
void addSeparator ()
 
void clear ()
 
void dump ()
 
bool isContentTypeEnabled (ContentType type) const
 
bool isLogging () const
 
QStringList logEntries () const
 
long maxLogSize () const
 
bool saveToFile (const QString &fileName) const
 
void setContentTypeEnabled (ContentType type, bool enabled)
 
void setLogging (bool active)
 
void setMaxLogSize (long size=-1)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static FilterLoginstance ()
 
static QString recode (const QString &plain)
 
- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

KMail Filter Log Collector.

The filter log helps to collect log information about the filter process in KMail. It's implemented as singleton, so it's easy to direct pieces of information to a unique instance. It's possible to activate / deactivate logging. All collected log information can get thrown away, the next added log entry is the first one until another clearing. A signal is emitted whenever a new logentry is added, when the log was cleared or any log state was changed.

Author
Andreas Gungl a.gun[email protected][email protected][email protected]mx.de

Definition at line 32 of file filterlog.h.

Member Enumeration Documentation

◆ ContentType

Describes the type of content that will be logged.

Enumerator
Meta 

Log all meta data.

PatternDescription 

Log all pattern description.

RuleResult 

Log all rule matching results.

PatternResult 

Log all pattern matching results.

AppliedAction 

Log all applied actions.

Definition at line 50 of file filterlog.h.

Constructor & Destructor Documentation

◆ ~FilterLog()

FilterLog::~FilterLog ( )
overridedefault

Destroys the filter log.

Member Function Documentation

◆ add()

void FilterLog::add ( const QString entry,
ContentType  type 
)

Adds the given log entry under the given content type to the log.

Definition at line 129 of file filterlog.cpp.

◆ addSeparator()

void FilterLog::addSeparator ( )

Adds a separator line to the log.

Definition at line 146 of file filterlog.cpp.

◆ clear()

void FilterLog::clear ( )

Clears the log.

Definition at line 151 of file filterlog.cpp.

◆ dump()

void FilterLog::dump ( )

Dumps the log to console.

Used for debugging.

Definition at line 162 of file filterlog.cpp.

◆ instance()

FilterLog * FilterLog::instance ( )
static

Returns the single global instance of the filter log.

Definition at line 72 of file filterlog.cpp.

◆ isContentTypeEnabled()

bool FilterLog::isContentTypeEnabled ( ContentType  type) const

Returns whether the given content type is enabled for logging.

Definition at line 124 of file filterlog.cpp.

◆ isLogging()

bool FilterLog::isLogging ( ) const

Returns whether the filter log is currently active.

Definition at line 81 of file filterlog.cpp.

◆ logEntries()

QStringList FilterLog::logEntries ( ) const

Returns the list of log entries.

Definition at line 157 of file filterlog.cpp.

◆ logEntryAdded

void MailCommon::FilterLog::logEntryAdded ( const QString entry)
signal

This signal is emitted whenever a new entry has been added to the log.

◆ logShrinked

void MailCommon::FilterLog::logShrinked ( )
signal

This signal is emitted whenever the log has shrunk.

◆ logStateChanged

void MailCommon::FilterLog::logStateChanged ( )
signal

This signal is emitted whenever the activity of the filter log has been changed.

◆ maxLogSize()

long FilterLog::maxLogSize ( ) const

Returns the maximum size of the log in bytes.

Definition at line 108 of file filterlog.cpp.

◆ recode()

QString FilterLog::recode ( const QString plain)
static

Returns an escaped version of the log which can be used in a HTML document.

Definition at line 189 of file filterlog.cpp.

◆ saveToFile()

bool FilterLog::saveToFile ( const QString fileName) const

Saves the log to the file with the given fileName.

Returns
true on success or false on failure.

Definition at line 171 of file filterlog.cpp.

◆ setContentTypeEnabled()

void FilterLog::setContentTypeEnabled ( ContentType  type,
bool  enabled 
)

Sets whether a given content type will be enabled for logging.

Definition at line 113 of file filterlog.cpp.

◆ setLogging()

void FilterLog::setLogging ( bool  active)

Sets whether the filter log is currently active.

Definition at line 86 of file filterlog.cpp.

◆ setMaxLogSize()

void FilterLog::setMaxLogSize ( long  size = -1)

Sets the maximum size of the log in bytes.

Definition at line 92 of file filterlog.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Oct 3 2022 04:00:28 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.