kmail

Public Member Functions | Protected Attributes | List of all members
KMFolderDir Class Reference

#include <kmfolderdir.h>

Public Member Functions

 KMFolderDir (KMFolder *owner, KMFolderDir *parent=0, const TQString &path=TQString(), KMFolderDirType=KMStandardDir)
virtual bool isDir () const
void addDirToParent (const TQString &dirName, KMFolder *parentFolder)
virtual bool reload ()
virtual TQString path () const
TQString label () const
virtual TQString prettyURL () const
virtual KMFolder * createFolder (const TQString &folderName, bool sysFldr=false, KMFolderType folderType=KMFolderTypeMbox)
virtual KMFolderNode * hasNamedFolder (const TQString &name)
virtual KMFolderMgr * manager () const
KMFolder * owner () const
virtual KMFolderDirType type () const

Protected Attributes

KMFolder * mOwner
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.

Constructor & Destructor Documentation

◆ KMFolderDir()

KMFolderDir::KMFolderDir ( KMFolder * owner,
KMFolderDir * parent = 0,
const TQString & path = TQString(),
KMFolderDirType dirType = KMStandardDir )

Definition at line 78 of file kmfolderdir.cpp.

◆ ~KMFolderDir()

KMFolderDir::~KMFolderDir ( )
virtual

Definition at line 88 of file kmfolderdir.cpp.

Member Function Documentation

◆ addDirToParent()

void KMFolderDir::addDirToParent ( const TQString & dirName,
KMFolder * parentFolder )

Adds the given subdirectory of this directory to the associated folder.

Definition at line 167 of file kmfolderdir.cpp.

◆ createFolder()

KMFolder * KMFolderDir::createFolder ( const TQString & 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.

◆ hasNamedFolder()

KMFolderNode * KMFolderDir::hasNamedFolder ( const TQString & name)
virtual

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

Definition at line 343 of file kmfolderdir.cpp.

◆ isDir()

virtual bool KMFolderDir::isDir ( void ) const
inlinevirtual

Definition at line 26 of file kmfolderdir.h.

◆ label()

TQString KMFolderDir::label ( void ) const

Returns the label of the folder for visualization.

Definition at line 145 of file kmfolderdir.cpp.

◆ manager()

KMFolderMgr * KMFolderDir::manager ( ) const
virtual

Returns the folder manager that manages this folder.

Definition at line 355 of file kmfolderdir.cpp.

◆ owner()

KMFolder * KMFolderDir::owner ( ) const
inline

Returns the folder whose children we are holding.

Definition at line 59 of file kmfolderdir.h.

◆ path()

TQString KMFolderDir::path ( ) const
virtual

Return full pathname of this directory.

Definition at line 128 of file kmfolderdir.cpp.

◆ prettyURL()

TQString KMFolderDir::prettyURL ( ) const
virtual

URL of the node for visualization purposes.

Definition at line 155 of file kmfolderdir.cpp.

◆ reload()

bool KMFolderDir::reload ( void )
virtual

Read contents of directory.

Definition at line 193 of file kmfolderdir.cpp.

◆ type()

virtual KMFolderDirType KMFolderDir::type ( ) const
inlinevirtual

Definition at line 61 of file kmfolderdir.h.

Member Data Documentation

◆ mDirType

KMFolderDirType KMFolderDir::mDirType
protected

Definition at line 65 of file kmfolderdir.h.

◆ mOwner

KMFolder* KMFolderDir::mOwner
protected

Definition at line 64 of file kmfolderdir.h.

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