KDE 4.4 API Reference kmail
KMFolderNode Class Reference
#include <kmfoldernode.h>
Public Member Functions | |
| KMFolderNode (KMFolderDir *parent, const QString &name) | |
| virtual | ~KMFolderNode () |
| uint | id () const |
| virtual bool | isDir (void) const |
| virtual QString | label () const |
| QString | name () const |
| KMFolderDir * | parent (void) const |
| virtual QString | path () const |
| virtual QString | prettyUrl () const =0 |
| virtual void | setDir (bool aDir) |
| void | setId (uint id) |
| void | setName (const QString &aName) |
| void | setParent (KMFolderDir *aParent) |
Protected Attributes | |
| bool | mDir |
| uint | mId |
| QString | mName |
| KMFolderDir * | mParent |
Detailed Description
Definition at line 29 of file kmfoldernode.h.
Constructor & Destructor Documentation
| KMFolderNode::KMFolderNode | ( | KMFolderDir * | parent, | |
| const QString & | name | |||
| ) |
Definition at line 7 of file kmfoldernode.cpp.
| KMFolderNode::~KMFolderNode | ( | ) | [virtual] |
Definition at line 17 of file kmfoldernode.cpp.
Member Function Documentation
| uint KMFolderNode::id | ( | ) | const |
ID of the node.
Definition at line 54 of file kmfoldernode.cpp.
| bool KMFolderNode::isDir | ( | void | ) | const [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 in KMFolderDir.
Definition at line 22 of file kmfoldernode.cpp.
| QString KMFolderNode::label | ( | void | ) | const [virtual] |
Label of the node for visualzation purposes.
Default the same as the name.
Reimplemented in KMFolder, and KMFolderDir.
Definition at line 36 of file kmfoldernode.cpp.
| QString KMFolderNode::name | ( | ) | const [inline] |
| KMFolderDir * KMFolderNode::parent | ( | void | ) | const |
Returns ptr to owning directory object or 0 if none.
This is just a wrapper for convenient access.
Reimplemented from QObject.
Definition at line 42 of file kmfoldernode.cpp.
| QString KMFolderNode::path | ( | ) | const [virtual] |
Returns full path to the directory where this node is stored or 0 if the node has no parent.
Example: if this object represents a folder ~joe/Mail/inbox then path() returns "/home/joe/Mail" and name() returns "inbox".
Reimplemented in KMFolderDir, and KMFolderRootDir.
Definition at line 29 of file kmfoldernode.cpp.
| virtual QString KMFolderNode::prettyUrl | ( | ) | const [pure virtual] |
URL of the node for visualization purposes.
Implemented in KMFolder, KMFolderDir, and KMFolderRootDir.
| virtual void KMFolderNode::setDir | ( | bool | aDir | ) | [inline, virtual] |
Definition at line 42 of file kmfoldernode.h.
| void KMFolderNode::setId | ( | uint | id | ) | [inline] |
Definition at line 69 of file kmfoldernode.h.
| void KMFolderNode::setName | ( | const QString & | aName | ) | [inline] |
Definition at line 58 of file kmfoldernode.h.
| void KMFolderNode::setParent | ( | KMFolderDir * | aParent | ) |
Definition at line 48 of file kmfoldernode.cpp.
Member Data Documentation
bool KMFolderNode::mDir [protected] |
Definition at line 74 of file kmfoldernode.h.
uint KMFolderNode::mId [protected] |
Definition at line 75 of file kmfoldernode.h.
QString KMFolderNode::mName [protected] |
Definition at line 72 of file kmfoldernode.h.
KMFolderDir* KMFolderNode::mParent [protected] |
Definition at line 73 of file kmfoldernode.h.
The documentation for this class was generated from the following files:
