kmail Library API Documentation

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:

QPtrList List of all members.

Public Member Functions

 KMFolderDir (KMFolder *owner, KMFolderDir *parent=0, const QString &path=QString::null, KMFolderDirType=KMStandardDir)
virtual bool isDir () const
virtual bool reload ()
virtual QString path () const
QString label () const
virtual QString prettyURL () const
virtual KMFoldercreateFolder (const QString &folderName, bool sysFldr=FALSE, KMFolderType folderType=KMFolderTypeMbox)
virtual KMFolderNode * hasNamedFolder (const QString &name)
virtual KMFolderMgr * manager () const
virtual KMFolderDirType type ()

Protected Attributes

KMFoldermOwner
KMFolderDirType mDirType

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.


Member Function Documentation

bool KMFolderDir::reload  )  [virtual]
 

Read contents of directory.

Definition at line 176 of file kmfolderdir.cpp.

References KMFolder::fileName(), path(), and KMFolder::setChild().

Referenced by KMFolder::createChildFolder().

QString KMFolderDir::path  )  const [virtual]
 

Return full pathname of this directory.

Definition at line 139 of file kmfolderdir.cpp.

Referenced by reload(), and KMail::FolderDiaGeneralTab::save().

QString KMFolderDir::label  )  const
 

Returns the label of the folder for visualization.

Definition at line 156 of file kmfolderdir.cpp.

References KMFolder::label().

Referenced by prettyURL().

QString KMFolderDir::prettyURL  )  const [virtual]
 

URL of the node for visualization purposes.

Definition at line 166 of file kmfolderdir.cpp.

References label().

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 96 of file kmfolderdir.cpp.

References KMFolder::correctUnreadMsgsCount(), KMFolder::create(), createFolder(), and KMFolder::setSystemFolder().

Referenced by createFolder().

KMFolderNode * KMFolderDir::hasNamedFolder const QString name  )  [virtual]
 

Returns folder with given name or zero if it does not exist.

Definition at line 302 of file kmfolderdir.cpp.

References hasNamedFolder().

Referenced by hasNamedFolder(), and KMail::FolderDiaGeneralTab::save().

KMFolderMgr * KMFolderDir::manager  )  const [virtual]
 

Returns the folder manager that manages this folder.

Definition at line 314 of file kmfolderdir.cpp.

Referenced by KMFolder::KMFolder().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 19:46:52 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003