Attica::Folder

Attica::Folder Class Reference

#include <folder.h>

Public Types

typedef QList< FolderList
 

Public Member Functions

 Folder ()
 
 Folder (const Folder &other)
 
 ~Folder ()
 
QString id () const
 
bool isValid () const
 
int messageCount () const
 
QString name () const
 
Folderoperator= (const Folder &other)
 
void setId (const QString &id)
 
void setMessageCount (int messageCount)
 
void setName (const QString &name)
 
void setType (const QString &type)
 
QString type () const
 

Detailed Description

Represents a single mail folder.

Definition at line 23 of file folder.h.

Constructor & Destructor Documentation

Folder::Folder ( )

Creates an empty Folder.

Definition at line 27 of file folder.cpp.

Folder::Folder ( const Folder other)

Copy constructor.

Parameters
otherthe Folder to copy from

Definition at line 32 of file folder.cpp.

Folder::~Folder ( )

Destructor.

Definition at line 43 of file folder.cpp.

Member Function Documentation

QString Folder::id ( ) const

Gets the id of the Folder.

The id uniquely identifies a Folder with the OCS API.

Returns
the id

Definition at line 52 of file folder.cpp.

bool Folder::isValid ( ) const

Checks whether this Folder has an id.

Returns
true if an id has been set, false otherwise

Definition at line 87 of file folder.cpp.

int Folder::messageCount ( ) const

Gets the number of messages in the Folder.

Returns
the number of messages

Definition at line 72 of file folder.cpp.

QString Folder::name ( ) const

Gets the name of the Folder.

Returns
the name

Definition at line 62 of file folder.cpp.

Folder & Folder::operator= ( const Folder other)

Assignment operator.

Parameters
otherthe Folder to assign from
Returns
pointer to this Folder

Definition at line 37 of file folder.cpp.

void Folder::setId ( const QString id)

Sets the id of the Folder.

The id uniquely identifies a Folder with the OCS API.

Parameters
idthe new id

Definition at line 47 of file folder.cpp.

void Folder::setMessageCount ( int  messageCount)

Sets the number of messages in the Folder.

Parameters
messageCountthe new number of messages

Definition at line 67 of file folder.cpp.

void Folder::setName ( const QString name)

Sets the name of the Folder.

Parameters
namethe new name

Definition at line 57 of file folder.cpp.

void Folder::setType ( const QString type)

Sets the type of the folder.

Parameters
typethe new type

Definition at line 77 of file folder.cpp.

QString Folder::type ( ) const

Gets the type of the Folder.

Returns
the type

Definition at line 82 of file folder.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Aug 6 2020 23:00:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.