KDE 4.1 API Reference kmail
KMFolderDir Class Reference
#include <kmfolderdir.h>
Detailed Description
KMail list that manages the contents of one directory that may contain folders and/or other directories.Definition at line 16 of file kmfolderdir.h.
Public Member Functions | |
| virtual KMFolder * | createFolder (const QString &folderName, bool sysFldr=false, KMFolderType folderType=KMFolderTypeMbox) |
| virtual KMFolderNode * | hasNamedFolder (const QString &name) |
| virtual bool | isDir () const |
| KMFolderDir (KMFolder *owner, KMFolderDir *parent=0, const QString &path=QString(), KMFolderDirType=KMStandardDir) | |
| QString | label () const |
| virtual KMFolderMgr * | manager () const |
| KMFolder * | owner () const |
| virtual QString | path () const |
| virtual QString | prettyUrl () const |
| virtual bool | reload () |
| virtual KMFolderDirType | type () const |
| virtual | ~KMFolderDir () |
Protected Attributes | |
| KMFolderDirType | mDirType |
| KMFolder * | mOwner |
Constructor & Destructor Documentation
| KMFolderDir::KMFolderDir | ( | KMFolder * | owner, | |
| KMFolderDir * | parent = 0, |
|||
| const QString & | path = QString(), |
|||
| KMFolderDirType | dirType = KMStandardDir | |||
| ) | [explicit] |
Definition at line 81 of file kmfolderdir.cpp.
| KMFolderDir::~KMFolderDir | ( | ) | [virtual] |
Definition at line 89 of file kmfolderdir.cpp.
Member Function Documentation
| KMFolder * KMFolderDir::createFolder | ( | const QString & | folderName, | |
| bool | sysFldr = false, |
|||
| KMFolderType | folderType = KMFolderTypeMbox | |||
| ) | [virtual] |
Create a mail folder in this directory with given name.
If sysFldr==true the folder is marked as a (KMail) system folder. Returns Folder on success.
Definition at line 97 of file kmfolderdir.cpp.
| KMFolderNode * KMFolderDir::hasNamedFolder | ( | const QString & | name | ) | [virtual] |
Returns folder with given name or zero if it does not exist.
Definition at line 309 of file kmfolderdir.cpp.
| virtual bool KMFolderDir::isDir | ( | void | ) | const [inline, virtual] |
Is it a directory where mail folders are stored or is it a folder that contains mail ? Note that there are some kinds of mail folders like the type mh uses that are directories on disk but are handled as folders here.
Reimplemented from KMFolderNode.
Definition at line 26 of file kmfolderdir.h.
| QString KMFolderDir::label | ( | void | ) | const [virtual] |
Returns the label of the folder for visualization.
Reimplemented from KMFolderNode.
Definition at line 150 of file kmfolderdir.cpp.
| KMFolderMgr * KMFolderDir::manager | ( | ) | const [virtual] |
Returns the folder manager that manages this folder.
Reimplemented in KMFolderRootDir.
Definition at line 323 of file kmfolderdir.cpp.
| KMFolder* KMFolderDir::owner | ( | ) | const [inline] |
| QString KMFolderDir::path | ( | ) | const [virtual] |
Return full pathname of this directory.
Reimplemented from KMFolderNode.
Reimplemented in KMFolderRootDir.
Definition at line 133 of file kmfolderdir.cpp.
| QString KMFolderDir::prettyUrl | ( | ) | const [virtual] |
URL of the node for visualization purposes.
Implements KMFolderNode.
Reimplemented in KMFolderRootDir.
Definition at line 160 of file kmfolderdir.cpp.
| bool KMFolderDir::reload | ( | void | ) | [virtual] |
| virtual KMFolderDirType KMFolderDir::type | ( | ) | const [inline, virtual] |
Definition at line 56 of file kmfolderdir.h.
Member Data Documentation
KMFolderDirType KMFolderDir::mDirType [protected] |
Definition at line 60 of file kmfolderdir.h.
KMFolder* KMFolderDir::mOwner [protected] |
Definition at line 59 of file kmfolderdir.h.
The documentation for this class was generated from the following files:
