kmail

KMFolderDir Class Reference

KMail list that manages the contents of one directory that may contain folders and/or other directories. More...

#include <kmfolderdir.h>

Inheritance diagram for KMFolderDir:

List of all members.


Public Member Functions

virtual KMFoldercreateFolder (const QString &folderName, bool sysFldr=false, KMFolderType folderType=KMFolderTypeMbox)
virtual KMFolderNodehasNamedFolder (const QString &name)
virtual bool isDir () const
 KMFolderDir (KMFolder *owner, KMFolderDir *parent=0, const QString &path=QString::null, KMFolderDirType=KMStandardDir)
QString label () const
virtual KMFolderMgrmanager () const
KMFolderowner () const
virtual QString path () const
virtual QString prettyURL () const
virtual bool reload ()
virtual KMFolderDirType type () const
virtual ~KMFolderDir ()

Protected Attributes

KMFolderDirType mDirType
KMFoldermOwner

Detailed Description

KMail list that manages the contents of one directory that may contain folders and/or other directories.

Definition at line 15 of file kmfolderdir.h.


Constructor & Destructor Documentation

KMFolderDir::KMFolderDir ( KMFolder owner,
KMFolderDir parent = 0,
const QString path = QString::null,
KMFolderDirType  dirType = KMStandardDir 
)

Definition at line 78 of file kmfolderdir.cpp.

KMFolderDir::~KMFolderDir (  )  [virtual]

Definition at line 88 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 95 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 294 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 25 of file kmfolderdir.h.

QString KMFolderDir::label ( void   )  const [virtual]

Returns the label of the folder for visualization.

Reimplemented from KMFolderNode.

Definition at line 145 of file kmfolderdir.cpp.

KMFolderMgr * KMFolderDir::manager (  )  const [virtual]

Returns the folder manager that manages this folder.

Reimplemented in KMFolderRootDir.

Definition at line 306 of file kmfolderdir.cpp.

KMFolder* KMFolderDir::owner (  )  const [inline]

Returns the folder whose children we are holding.

Definition at line 53 of file kmfolderdir.h.

QString KMFolderDir::path (  )  const [virtual]

Return full pathname of this directory.

Reimplemented from KMFolderNode.

Reimplemented in KMFolderRootDir.

Definition at line 128 of file kmfolderdir.cpp.

QString KMFolderDir::prettyURL (  )  const [virtual]

URL of the node for visualization purposes.

Implements KMFolderNode.

Reimplemented in KMFolderRootDir.

Definition at line 155 of file kmfolderdir.cpp.

bool KMFolderDir::reload ( void   )  [virtual]

Read contents of directory.

Definition at line 168 of file kmfolderdir.cpp.

virtual KMFolderDirType KMFolderDir::type ( void   )  const [inline, virtual]

Definition at line 55 of file kmfolderdir.h.


Member Data Documentation

Definition at line 59 of file kmfolderdir.h.

Definition at line 58 of file kmfolderdir.h.


The documentation for this class was generated from the following files: