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>

List of all members.

Public Member Functions

 KMFolderDir (KMFolderDir *parent=0, const QString &path=QString::null, KMFolderDirType=KMStandardDir)
virtual bool isDir () const
virtual bool reload ()
virtual QString path () 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

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

Referenced by reload().

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

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

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

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

Definition at line 257 of file kmfolderdir.cpp.

KMFolderMgr * KMFolderDir::manager  )  const [virtual]
 

Returns the folder manager that manages this folder.

Definition at line 269 of file kmfolderdir.cpp.


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.2.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Mar 6 17:18:23 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003