kmail
KMail::ListJob Class Reference
#include <listjob.h>
Inheritance diagram for KMail::ListJob:

Detailed Description
Generic folder list job for (d)imap accounts.
Definition at line 54 of file listjob.h.
Signals | |
void | receivedFolders (const QStringList &, const QStringList &, const QStringList &, const QStringList &, const ImapAccountBase::jobData &) |
Public Member Functions | |
ListJob (ImapAccountBase *account, ImapAccountBase::ListType type, FolderStorage *storage=0, const QString &path=QString::null, bool complete=false, KPIM::ProgressItem *item=0) | |
virtual | ~ListJob () |
void | setHonorLocalSubscription (bool value) |
bool | honorLocalSubscription () const |
virtual void | execute () |
void | setPath (const QString &path) |
void | setStorage (FolderStorage *st) |
void | setComplete (bool complete) |
void | setParentProgressItem (KPIM::ProgressItem *it) |
void | setNamespace (const QString &ns) |
Protected Slots | |
void | slotListResult (KIO::Job *job) |
void | slotListEntries (KIO::Job *job, const KIO::UDSEntryList &uds) |
void | slotConnectionResult (int errorCode, const QString &errorMsg) |
Protected Attributes | |
FolderStorage * | mStorage |
ImapAccountBase * | mAccount |
ImapAccountBase::ListType | mType |
bool | mComplete |
bool | mHonorLocalSubscription |
QString | mPath |
QStringList | mSubfolderNames |
QStringList | mSubfolderPaths |
QStringList | mSubfolderMimeTypes |
QStringList | mSubfolderAttributes |
KPIM::ProgressItem * | mParentProgressItem |
QString | mNamespace |
Constructor & Destructor Documentation
ListJob::ListJob | ( | ImapAccountBase * | account, | |
ImapAccountBase::ListType | type, | |||
FolderStorage * | storage = 0 , |
|||
const QString & | path = QString::null , |
|||
bool | complete = false , |
|||
KPIM::ProgressItem * | item = 0 | |||
) |
Create a new job.
- Parameters:
-
storage the parent folder, either provide this or a path account the ImapAccountBase type Type of subscription complete list all folders or only next level path the listing path; if empty the path of the folder will be taken item a parent ProgressItem
Definition at line 53 of file listjob.cpp.
Member Function Documentation
void KMail::ListJob::setHonorLocalSubscription | ( | bool | value | ) |
Set whether the listing should include only folders that the account is subscribed to locally.
This is different from the server side subscription managed by the ctor parameter.
Definition at line 245 of file listjob.cpp.
bool KMail::ListJob::honorLocalSubscription | ( | ) | const |
Return whether the listing includes only folders that the account is subscribed to locally.
This is different from the server side subscription managed by the ctor parameter.
Definition at line 250 of file listjob.cpp.
void ListJob::execute | ( | ) | [virtual] |
Has to be reimplemented.
It's called by the start() method. Should start the processing of the specified job function.
Implements KMail::FolderJob.
Definition at line 68 of file listjob.cpp.
void KMail::ListJob::setPath | ( | const QString & | path | ) | [inline] |
void KMail::ListJob::setStorage | ( | FolderStorage * | st | ) | [inline] |
void KMail::ListJob::setComplete | ( | bool | complete | ) | [inline] |
void KMail::ListJob::setParentProgressItem | ( | KPIM::ProgressItem * | it | ) | [inline] |
void KMail::ListJob::setNamespace | ( | const QString & | ns | ) | [inline] |
void ListJob::slotListResult | ( | KIO::Job * | job | ) | [protected, slot] |
Is called when the listing is done Passes the folders and the jobData to the responding folder.
Definition at line 166 of file listjob.cpp.
void ListJob::slotListEntries | ( | KIO::Job * | job, | |
const KIO::UDSEntryList & | uds | |||
) | [protected, slot] |
void ListJob::slotConnectionResult | ( | int | errorCode, | |
const QString & | errorMsg | |||
) | [protected, slot] |
Called from the account when a connection was established.
Definition at line 154 of file listjob.cpp.
void KMail::ListJob::receivedFolders | ( | const QStringList & | , | |
const QStringList & | , | |||
const QStringList & | , | |||
const QStringList & | , | |||
const ImapAccountBase::jobData & | ||||
) | [signal] |
Emitted when new folders have been received.
The documentation for this class was generated from the following files: