KDE 4.2 API Reference kmail
KMFolderMgr Class Reference
#include <kmfoldermgr.h>
Detailed Description
Definition at line 16 of file kmfoldermgr.h.
Public Slots | |
| void | compactAll () |
| void | expireAll () |
| void | removeFolderAux (KMFolder *obsoleteFolder, bool success) |
| void | slotRenameDone (const QString &newName, bool success) |
Signals | |
| void | changed () |
| void | folderAdded (KMFolder *) |
| void | folderInvalidated (KMFolder *) |
| void | folderMoveOrCopyOperationFinished () |
| void | folderRemoved (KMFolder *) |
| void | msgAdded (KMFolder *, quint32) |
| void | msgChanged (KMFolder *, quint32, int delta) |
| void | msgHeaderChanged (KMFolder *, int idx) |
| void | msgRemoved (KMFolder *, quint32) |
Public Member Functions | |
| QString | basePath () const |
| void | compactAllFolders (bool immediate, KMFolderDir *adir=0) |
| void | contentsChanged (void) |
| void | copyFolder (KMFolder *folder, KMFolderDir *newParent) |
| KMFolder * | createFolder (const QString &fName, bool sysFldr=false, KMFolderType aFolderType=KMFolderTypeMbox, KMFolderDir *aFolderDir=0) |
| void | createFolderList (QStringList *str, QList< QPointer< KMFolder > > *folders, KMFolderDir *adir, const QString &prefix, bool i18nized=false) |
| void | createFolderList (QStringList *str, QList< QPointer< KMFolder > > *folders) |
| void | createI18nFolderList (QStringList *str, QList< QPointer< KMFolder > > *folders) |
| uint | createId () |
| KMFolderRootDir & | dir () |
| void | expireAllFolders (bool immediate, KMFolderDir *adir=0) |
| KMFolder * | find (const QString &folderName, bool foldersOnly=true) const |
| KMFolder * | findById (const uint id) const |
| KMFolder * | findIdString (const QString &folderId, const uint id=0, const KMFolderDir *dir=0) const |
| KMFolder * | findOrCreate (const QString &folderName, bool sysFldr=true, const uint id=0) |
| int | folderCount (KMFolderDir *dir=0) |
| KMFolder * | getFolderByURL (const QString &vpath, const QString &prefix=QString(), const KMFolderDir *adir=0) const |
| void | getFolderURLS (QStringList &flist, const QString &prefix=QString(), const KMFolderDir *adir=0) const |
| KMFolderMgr (const QString &basePath, KMFolderDirType dirType=KMStandardDir) | |
| void | moveFolder (KMFolder *folder, KMFolderDir *newParent) |
| KMFolder * | parentFolder (KMFolder *folder) |
| void | quiet (bool) |
| void | reload (void) |
| void | remove (KMFolder *obsoleteFolder) |
| void | renameFolder (KMFolder *folder, const QString &newName, KMFolderDir *newParent=0) |
| void | setBasePath (const QString &) |
| void | syncAllFolders (KMFolderDir *adir=0) |
| void | tryReleasingFolder (KMFolder *folder, KMFolderDir *Dir=0) |
| ~KMFolderMgr () | |
Protected Member Functions | |
| void | removeDirAux (KMFolderDir *aFolderDir) |
| void | removeFolder (KMFolder *aFolder) |
Protected Attributes | |
| QString | mBasePath |
| bool | mChanged |
| KMFolderRootDir | mDir |
| int | mQuiet |
| KMFolder * | mRemoveOrig |
Constructor & Destructor Documentation
| KMFolderMgr::KMFolderMgr | ( | const QString & | basePath, | |
| KMFolderDirType | dirType = KMStandardDir | |||
| ) | [explicit] |
Definition at line 38 of file kmfoldermgr.cpp.
| KMFolderMgr::~KMFolderMgr | ( | ) |
Definition at line 51 of file kmfoldermgr.cpp.
Member Function Documentation
| QString KMFolderMgr::basePath | ( | ) | const [inline] |
| void KMFolderMgr::changed | ( | ) | [signal] |
Emitted when the list of folders has changed.
This signal is a hook where clients like the KMFolderTree tree-view can connect. The signal is meant to be emitted whenever the code using the folder-manager changed things.
| void KMFolderMgr::compactAll | ( | ) | [inline, slot] |
GUI action: compact all folders that need to be compacted.
Definition at line 129 of file kmfoldermgr.h.
| void KMFolderMgr::compactAllFolders | ( | bool | immediate, | |
| KMFolderDir * | adir = 0 | |||
| ) |
Compact all folders that need to be, either immediately or scheduled as a background task.
Definition at line 107 of file kmfoldermgr.cpp.
| void KMFolderMgr::contentsChanged | ( | void | ) |
| void KMFolderMgr::copyFolder | ( | KMFolder * | folder, | |
| KMFolderDir * | newParent | |||
| ) |
| KMFolder * KMFolderMgr::createFolder | ( | const QString & | fName, | |
| bool | sysFldr = false, |
|||
| KMFolderType | aFolderType = KMFolderTypeMbox, |
|||
| KMFolderDir * | aFolderDir = 0 | |||
| ) |
Create a mail folder in the root folder directory dir() with given name.
Returns Folder on success.
Definition at line 170 of file kmfoldermgr.cpp.
| void KMFolderMgr::createFolderList | ( | QStringList * | str, | |
| QList< QPointer< KMFolder > > * | folders, | |||
| KMFolderDir * | adir, | |||
| const QString & | prefix, | |||
| bool | i18nized = false | |||
| ) |
Auxillary function to facilitate creating a list of formatted folder names, suitable for showing in QComboBox.
Definition at line 463 of file kmfoldermgr.cpp.
| void KMFolderMgr::createFolderList | ( | QStringList * | str, | |
| QList< QPointer< KMFolder > > * | folders | |||
| ) |
Create a list of formatted formatted folder labels and corresponding folders.
Definition at line 449 of file kmfoldermgr.cpp.
| void KMFolderMgr::createI18nFolderList | ( | QStringList * | str, | |
| QList< QPointer< KMFolder > > * | folders | |||
| ) |
Create a list of formatted formatted folder labels and corresponding folders.
The system folder names are translated
Definition at line 456 of file kmfoldermgr.cpp.
| uint KMFolderMgr::createId | ( | ) |
| KMFolderRootDir & KMFolderMgr::dir | ( | void | ) |
| void KMFolderMgr::expireAll | ( | ) | [slot] |
| void KMFolderMgr::expireAllFolders | ( | bool | immediate, | |
| KMFolderDir * | adir = 0 | |||
| ) |
Expire old messages in all folders, either immediately or scheduled as a background task.
Check each folder in turn to see if it is configured to AutoExpire.
If so, expire old messages.
Should be called with 0 first time around.
Definition at line 508 of file kmfoldermgr.cpp.
Searches folder and returns it.
Skips directories (objects of type KMFolderDir) if foldersOnly is true.
Definition at line 215 of file kmfoldermgr.cpp.
| KMFolder * KMFolderMgr::findById | ( | const uint | id | ) | const |
Searches folder by id and returns it.
Skips directories (objects of type KMFolderDir)
Definition at line 228 of file kmfoldermgr.cpp.
| KMFolder * KMFolderMgr::findIdString | ( | const QString & | folderId, | |
| const uint | id = 0, |
|||
| const KMFolderDir * | dir = 0 | |||
| ) | const |
Searches for a folder with the given id, recurses into directories.
Definition at line 234 of file kmfoldermgr.cpp.
| KMFolder * KMFolderMgr::findOrCreate | ( | const QString & | folderName, | |
| bool | sysFldr = true, |
|||
| const uint | id = 0 | |||
| ) |
Uses find() to find given folder.
If not found the folder is created. Directories are skipped. If an id is passed this searches for it
Definition at line 294 of file kmfoldermgr.cpp.
| void KMFolderMgr::folderAdded | ( | KMFolder * | ) | [signal] |
Emitted, when a folder has been added.
| int KMFolderMgr::folderCount | ( | KMFolderDir * | dir = 0 |
) |
| void KMFolderMgr::folderInvalidated | ( | KMFolder * | ) | [signal] |
Emitted, when serial numbers for a folder have been invalidated.
| void KMFolderMgr::folderMoveOrCopyOperationFinished | ( | ) | [signal] |
Emitted when a folder has been moved or copied.
| void KMFolderMgr::folderRemoved | ( | KMFolder * | ) | [signal] |
Emitted, when a folder is about to be removed.
| KMFolder * KMFolderMgr::getFolderByURL | ( | const QString & | vpath, | |
| const QString & | prefix = QString(), |
|||
| const KMFolderDir * | adir = 0 | |||
| ) | const |
Definition at line 272 of file kmfoldermgr.cpp.
| void KMFolderMgr::getFolderURLS | ( | QStringList & | flist, | |
| const QString & | prefix = QString(), |
|||
| const KMFolderDir * | adir = 0 | |||
| ) | const |
Definition at line 257 of file kmfoldermgr.cpp.
| void KMFolderMgr::moveFolder | ( | KMFolder * | folder, | |
| KMFolderDir * | newParent | |||
| ) |
| void KMFolderMgr::msgAdded | ( | KMFolder * | , | |
| quint32 | ||||
| ) | [signal] |
Emitted, when a message has been appended to a folder.
| void KMFolderMgr::msgChanged | ( | KMFolder * | , | |
| quint32 | , | |||
| int | delta | |||
| ) | [signal] |
Emitted, when the status of a message is changed.
| void KMFolderMgr::msgHeaderChanged | ( | KMFolder * | , | |
| int | idx | |||
| ) | [signal] |
Emitted when a field of the header of a specific message changed.
| void KMFolderMgr::msgRemoved | ( | KMFolder * | , | |
| quint32 | ||||
| ) | [signal] |
Emitted, when a message has been removed from a folder.
Returns the parent Folder for the given folder or 0 on failure.
Definition at line 364 of file kmfoldermgr.cpp.
| void KMFolderMgr::quiet | ( | bool | beQuiet | ) |
| void KMFolderMgr::reload | ( | void | ) |
| void KMFolderMgr::remove | ( | KMFolder * | obsoleteFolder | ) |
Physically remove given folder and delete the given folder object.
Definition at line 333 of file kmfoldermgr.cpp.
| void KMFolderMgr::removeDirAux | ( | KMFolderDir * | aFolderDir | ) | [protected] |
Auxillary function to facilitate removal of a folder directory.
Definition at line 419 of file kmfoldermgr.cpp.
| void KMFolderMgr::removeFolder | ( | KMFolder * | aFolder | ) | [protected] |
Auxillary function to facilitate removal of a folder.
Definition at line 357 of file kmfoldermgr.cpp.
| void KMFolderMgr::removeFolderAux | ( | KMFolder * | obsoleteFolder, | |
| bool | success | |||
| ) | [slot] |
Called from KMFolder::remove when the folderstorage was removed.
Definition at line 380 of file kmfoldermgr.cpp.
| void KMFolderMgr::renameFolder | ( | KMFolder * | folder, | |
| const QString & | newName, | |||
| KMFolderDir * | newParent = 0 | |||
| ) |
| void KMFolderMgr::setBasePath | ( | const QString & | aBasePath | ) |
Set base path.
Also calls reload() on the base directory.
Definition at line 124 of file kmfoldermgr.cpp.
| void KMFolderMgr::slotRenameDone | ( | const QString & | newName, | |
| bool | success | |||
| ) | [slot] |
| void KMFolderMgr::syncAllFolders | ( | KMFolderDir * | adir = 0 |
) |
| void KMFolderMgr::tryReleasingFolder | ( | KMFolder * | folder, | |
| KMFolderDir * | Dir = 0 | |||
| ) |
Try closing folder if possible, something is attempting an exclusive access to it.
Currently used for KMFolderSearch and the background tasks like expiry
Definition at line 540 of file kmfoldermgr.cpp.
Member Data Documentation
QString KMFolderMgr::mBasePath [protected] |
Definition at line 179 of file kmfoldermgr.h.
bool KMFolderMgr::mChanged [protected] |
Definition at line 182 of file kmfoldermgr.h.
KMFolderRootDir KMFolderMgr::mDir [protected] |
Definition at line 180 of file kmfoldermgr.h.
int KMFolderMgr::mQuiet [protected] |
Definition at line 181 of file kmfoldermgr.h.
KMFolder* KMFolderMgr::mRemoveOrig [protected] |
Definition at line 183 of file kmfoldermgr.h.
The documentation for this class was generated from the following files:
