Attica::Category Class Reference

#include <Attica/Category>

Public Types
typedef QList< Category >	List

Public Member Functions
	Category ()
	Category (const Category &other)
	~Category ()
QString	displayName () const
QString	id () const
bool	isValid () const
QString	name () const
Category &	operator= (const Category &other)
void	setDisplayName (const QString &name)
void	setId (const QString &)
void	setName (const QString &name)

Detailed Description

Represents a single content category.

Definition at line 23 of file category.h.

Member Typedef Documentation

List

QList<Category> Attica::Category::List

Definition at line 26 of file category.h.

Constructor & Destructor Documentation

Category() [1/2]

Category::Category

(

)

Creates an empty Category.

Definition at line 24 of file category.cpp.

Category() [2/2]

Category::Category

(

const Category &

other

)

Copy constructor.

Parameters

other

the Category to copy from

Definition at line 29 of file category.cpp.

~Category()

Category::~Category

(

)

Destructor.

Definition at line 40 of file category.cpp.

Member Function Documentation

displayName()

QString Category::displayName

(

)

const

Gets the display name of the Category.

This name is guaranteed to be user friendly, while name may be internal for the server

Returns

the name

Since

5.31

Definition at line 69 of file category.cpp.

id()

QString Category::id

(

)

const

Gets the id of the Category.

The id uniquely identifies a Category with the OCS API.

Returns

the id

Definition at line 49 of file category.cpp.

isValid()

bool Category::isValid

(

)

const

Checks whether this Category has an id.

Returns

true if an id has been set, false otherwise

Definition at line 74 of file category.cpp.

name()

QString Category::name

(

)

const

Gets the name of the Category.

Returns

the name

Definition at line 59 of file category.cpp.

operator=()

Category & Category::operator=

(

const Category &

other

)

Assignment operator.

Parameters

other

the Category to assign from

Returns

pointer to this Category

Definition at line 34 of file category.cpp.

setDisplayName()

void Category::setDisplayName

(

const QString &

name

)

Sets the display name of the Category.

This name is guaranteed to be user friendly, while name may be internal for the server

Parameters

name	the new name

Since

5.31

Definition at line 64 of file category.cpp.

setId()

void Category::setId

(

const QString &

u

)

Sets the id of the Category.

The id uniquely identifies a Category with the OCS API.

Parameters

id	the new id

Definition at line 44 of file category.cpp.

setName()

void Category::setName

(

const QString &

name

)

Sets the name of the Category.

Parameters

name	the new name

Definition at line 54 of file category.cpp.

---

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

• category.h
• category.cpp