Attica::Folder Class Reference

#include <Attica/Folder>

Public Types
typedef QList< Folder >	List

Public Member Functions
	Folder ()
	Folder (const Folder &other)
	~Folder ()
QString	id () const
bool	isValid () const
int	messageCount () const
QString	name () const
Folder &	operator= (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 24 of file folder.h.

Member Typedef Documentation

List

QList<Folder> Attica::Folder::List

Definition at line 27 of file folder.h.

Constructor & Destructor Documentation

Folder() [1/2]

Folder::Folder

(

)

Creates an empty Folder.

Definition at line 27 of file folder.cpp.

Folder() [2/2]

Folder::Folder

(

const Folder &

other

)

Copy constructor.

Parameters

other

the Folder to copy from

Definition at line 32 of file folder.cpp.

~Folder()

Folder::~Folder

(

)

Destructor.

Definition at line 43 of file folder.cpp.

Member Function Documentation

id()

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.

isValid()

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.

messageCount()

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.

name()

QString Folder::name

(

)

const

Gets the name of the Folder.

Returns

the name

Definition at line 62 of file folder.cpp.

operator=()

Folder & Folder::operator=

(

const Folder &

other

)

Assignment operator.

Parameters

other

the Folder to assign from

Returns

pointer to this Folder

Definition at line 37 of file folder.cpp.

setId()

void Folder::setId

(

const QString &

id

)

Sets the id of the Folder.

The id uniquely identifies a Folder with the OCS API.

Parameters

id	the new id

Definition at line 47 of file folder.cpp.

setMessageCount()

void Folder::setMessageCount

(

int

messageCount

)

Sets the number of messages in the Folder.

Parameters

messageCount

the new number of messages

Definition at line 67 of file folder.cpp.

setName()

void Folder::setName

(

const QString &

name

)

Sets the name of the Folder.

Parameters

name	the new name

Definition at line 57 of file folder.cpp.

setType()

void Folder::setType

(

const QString &

type

)

Sets the type of the folder.

Parameters

type	the new type

Definition at line 77 of file folder.cpp.

type()

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:

• folder.h
• folder.cpp