kmail

KMFolderNode Class Reference

Inheritance diagram for KMFolderNode:

KMFolder KMFolderDir KMAcctFolder KMFolderRootDir List of all members.

Detailed Description

Definition at line 29 of file kmfoldernode.h.


Public Member Functions

 KMFolderNode (KMFolderDir *parent, const QString &name)
virtual ~KMFolderNode ()
virtual bool isDir (void) const
virtual void setDir (bool aDir)
KMFolderDirparent (void) const
void setParent (KMFolderDir *aParent)
virtual QString path () const
QString name () const
void setName (const QString &aName)
virtual QString label () const
virtual QString prettyURL () const=0
uint id () const
void setId (uint id)

Protected Attributes

QString mName
KMFolderDirmParent
bool mDir
uint mId

Member Function Documentation

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 25 of file kmfoldernode.cpp.

KMFolderDir * KMFolderNode::parent ( void   )  const

Returns ptr to owning directory object or 0 if none.

This is just a wrapper for convenient access.

Definition at line 45 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 32 of file kmfoldernode.cpp.

QString KMFolderNode::name (  )  const [inline]

Name of the node.

Also used as file name.

Definition at line 57 of file kmfoldernode.h.

QString KMFolderNode::label (  )  const [virtual]

Label of the node for visualzation purposes.

Default the same as the name.

Reimplemented in KMFolder, and KMFolderDir.

Definition at line 39 of file kmfoldernode.cpp.

virtual QString KMFolderNode::prettyURL (  )  const [pure virtual]

URL of the node for visualization purposes.

Implemented in KMFolder, KMFolderDir, and KMFolderRootDir.

uint KMFolderNode::id (  )  const

ID of the node.

Definition at line 57 of file kmfoldernode.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys