FilterLog Class Reference

This is the log of the filters. More...

#include <filterlog.h>

List of all members.

Public Member Functions

 FilterLog ()
 ~FilterLog ()
void addDeletedMail (const KDateTime &dateTime, const QString &sender, const QString &account, const QString &subject)
void addMovedMail (const KDateTime &dateTime, const QString &sender, const QString &account, const QString &subject, const QString &mailbox)
void print ()
void clearDeletedMailsLog ()
void clearMovedMailsLog ()
void save ()
void load ()
LogEntryList getDeletedMails ()
LogEntryList getMovedMails ()
void loadSetup ()
int numberDeletedMails ()
int numberMovedMails ()

Protected Member Functions

void addEntry (FilterAction_Type action, const KDateTime &dateTime, const QString &sender, const QString &account, const QString &subject, const QString &mailbox=QString())
 Adds an entry.


Detailed Description

This is the log of the filters.

It holds two lists of entry objects (class FilterLogEntry). One for the deleted mails and the other one for the moved mails.

Author:
Ulrich Weigelt <ulrich.weigelt@gmx.de>

Definition at line 52 of file filterlog.h.


Constructor & Destructor Documentation

FilterLog::FilterLog (  ) 

Default constructor

Definition at line 20 of file filterlog.cpp.

FilterLog::~FilterLog (  ) 

Destructor

Definition at line 33 of file filterlog.cpp.


Member Function Documentation

void FilterLog::addDeletedMail ( const KDateTime &  dateTime,
const QString &  sender,
const QString &  account,
const QString &  subject 
)

Adds an entry about a deleted mail.

Parameters:
dateTime date and time on which the mail was sent
sender sender of the mail
account Account which has received the mail
subject Subject of the mail

Definition at line 37 of file filterlog.cpp.

void FilterLog::addMovedMail ( const KDateTime &  dateTime,
const QString &  sender,
const QString &  account,
const QString &  subject,
const QString &  mailbox 
)

Adds an entry about a moved mail.

Parameters:
dateTime date and time on which the mail was sent
sender sender of the mail
account Account which has received the mail
subject Subject of the mail
mailbox mailbox

Definition at line 43 of file filterlog.cpp.

void FilterLog::print (  ) 

Prints the log state.

Definition at line 65 of file filterlog.cpp.

void FilterLog::clearDeletedMailsLog (  ) 

Clears the log of deleted mails.

Definition at line 84 of file filterlog.cpp.

void FilterLog::clearMovedMailsLog (  ) 

Clears the log of moved mails.

Definition at line 89 of file filterlog.cpp.

void FilterLog::save (  ) 

Saved the log of deleted mails as XML document.

Definition at line 94 of file filterlog.cpp.

void FilterLog::load (  ) 

Loads the log of deleted mails from the XML document and get settings.

Definition at line 138 of file filterlog.cpp.

LogEntryList FilterLog::getDeletedMails (  ) 

Returns a copy of the list of deleted mails.

Returns:
copy of the deleted mails list

Definition at line 191 of file filterlog.cpp.

LogEntryList FilterLog::getMovedMails (  ) 

Retruns a copy of the list of moved mails.

Returns:
copy of the moved mails list

Definition at line 196 of file filterlog.cpp.

void FilterLog::loadSetup (  ) 

Loads the settings

Definition at line 201 of file filterlog.cpp.

int FilterLog::numberDeletedMails (  ) 

Returns the number of logged deleted mails.

Returns:
number of logged deleted mails

Definition at line 230 of file filterlog.cpp.

int FilterLog::numberMovedMails (  ) 

Returns the number of logged moved mails.

Returns:
number of logged moved mails

Definition at line 235 of file filterlog.cpp.

void FilterLog::addEntry ( FilterAction_Type  action,
const KDateTime &  dateTime,
const QString &  sender,
const QString &  account,
const QString &  subject,
const QString &  mailbox = QString() 
) [protected]

Adds an entry.

The target list will be coose on the basis of the given filter action.

Parameters:
action the performed action
dateTime send time of the mail
sender sender of the mail
account account
subject mail subject
mailbox mailbox if the mail was moved

Definition at line 49 of file filterlog.cpp.


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

Generated on Tue May 18 19:43:53 2010 for KShowmail by  doxygen 1.5.6