KDE PIM / Developers / API Docs / kmail

KMail::FilterLog Class Reference

KMail Filter Log Collector. More...

#include <filterlog.h>

Inherits QObject.

List of all members.

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes


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.


Member Enumeration Documentation

enum KMail::FilterLog::ContentType
 

log data types


Constructor & Destructor Documentation

FilterLog::~FilterLog  )  [virtual]
 

destructor

FilterLog::FilterLog  )  [protected]
 

Non-public constructor needed by the singleton implementation.


Member Function Documentation

FilterLog * FilterLog::instance  )  [static]
 

access to the singleton instance

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

check the logging state

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

set the logging state

void FilterLog::setMaxLogSize long  size = -1  ) 
 

control the size of the log

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

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

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

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

void FilterLog::add QString  logEntry,
ContentType  contentType
 

add a log entry

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

add a separating line in the log

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

discard collected log data

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

get access to the log entries

void FilterLog::dump  ) 
 

dump the log - for testing purposes

bool FilterLog::saveToFile QString  fileName  ) 
 

save the log to a file - returns true if okay


Member Data Documentation

QStringList KMail::FilterLog::mLogEntries [protected]
 

The list contains the single log pieces.

bool KMail::FilterLog::mLogging [protected]
 

the log status

long KMail::FilterLog::mMaxLogSize [protected]
 

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

int KMail::FilterLog::mAllowedTypes [protected]
 

types currently allowed to be legged


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