kmail

KMail::FilterLog

KMail::FilterLog Class Reference

#include <filterlog.h>

List of all members.

Detailed Description

KMail Filter Log Collector.

Author:
Andreas Gungl <a.gungl@gmx.de>
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.

Definition at line 53 of file filterlog.h.


Public Types

enum  ContentType {
  meta = 1, patternDesc = 2, ruleResult = 4, patternResult = 8,
  appliedAction = 16
}

Signals

void logEntryAdded (QString)
void logShrinked ()
void logStateChanged ()

Public Member Functions

bool isLogging ()
void setLogging (bool active)
void setMaxLogSize (long size=-1)
long getMaxLogSize ()
void setContentTypeEnabled (ContentType contentType, bool b)
bool isContentTypeEnabled (ContentType contentType)
void add (QString logEntry, ContentType contentType)
void addSeparator ()
void clear ()
const QStringList & getLogEntries ()
void dump ()
bool saveToFile (QString fileName)
virtual ~FilterLog ()

Static Public Member Functions

static FilterLog * instance ()
static QString recode (const QString &plain)

Protected Member Functions

 FilterLog ()
void checkLogSize ()

Protected Attributes

QStringList mLogEntries
bool mLogging
long mMaxLogSize
long mCurrentLogSize
int mAllowedTypes

Member Enumeration Documentation

enum KMail::FilterLog::ContentType
 

log data types

Definition at line 62 of file filterlog.h.

Constructor & Destructor Documentation

FilterLog::~FilterLog (   )  [virtual]
 

destructor

Definition at line 60 of file filterlog.cpp.

FilterLog::FilterLog (   )  [protected]
 

Non-public constructor needed by the singleton implementation.

Definition at line 46 of file filterlog.cpp.

Member Function Documentation

void FilterLog::add (  QString  logEntry,
ContentType  contentType
) 
 

add a log entry

Definition at line 71 of file filterlog.cpp.

void KMail::FilterLog::addSeparator (   )  [inline]
 

add a separating line in the log

Definition at line 107 of file filterlog.h.

void KMail::FilterLog::clear (   )  [inline]
 

discard collected log data

Definition at line 109 of file filterlog.h.

void FilterLog::dump (   ) 
 

dump the log - for testing purposes

Definition at line 101 of file filterlog.cpp.

const QStringList& KMail::FilterLog::getLogEntries (   )  [inline]
 

get access to the log entries

Definition at line 118 of file filterlog.h.

FilterLog * FilterLog::instance (   )  [static]
 

access to the singleton instance

Definition at line 64 of file filterlog.cpp.

bool KMail::FilterLog::isContentTypeEnabled (  ContentType  contentType  )  [inline]
 

check a content type for inclusion in the set of logged ones

Definition at line 98 of file filterlog.h.

bool KMail::FilterLog::isLogging (   )  [inline]
 

check the logging state

Definition at line 73 of file filterlog.h.

bool FilterLog::saveToFile (  QString  fileName  ) 
 

save the log to a file - returns true if okay

Definition at line 143 of file filterlog.cpp.

void KMail::FilterLog::setContentTypeEnabled (  ContentType  contentType,
bool  b
)  [inline]
 

add/remove a content type to the set of logged ones

Definition at line 88 of file filterlog.h.

void KMail::FilterLog::setLogging (  bool  active  )  [inline]
 

set the logging state

Definition at line 75 of file filterlog.h.

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

control the size of the log

Definition at line 88 of file filterlog.cpp.

Member Data Documentation

int KMail::FilterLog::mAllowedTypes [protected]
 

types currently allowed to be legged

Definition at line 151 of file filterlog.h.

QStringList KMail::FilterLog::mLogEntries [protected]
 

The list contains the single log pieces.

Definition at line 139 of file filterlog.h.

bool KMail::FilterLog::mLogging [protected]
 

the log status

Definition at line 142 of file filterlog.h.

long KMail::FilterLog::mMaxLogSize [protected]
 

max size for kept log items, when reached the last recently added items are discarded -1 means unlimited

Definition at line 147 of file filterlog.h.

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

kmail

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys