Attica 5.109.0
Public Types | Public Member Functions | List of all members
Attica::Category

Represents a single content category. More...

#include <Attica/Category>

Public Types

typedef QList< CategoryList
 

Public Member Functions

 Category ()
 Creates an empty Category.
 
 Category (const Category &other)
 Copy constructor.
 
 ~Category ()
 Destructor.
 
QString displayName () const
 Gets the display name of the Category.
 
QString id () const
 Gets the id of the Category.
 
bool isValid () const
 Checks whether this Category has an id.
 
QString name () const
 Gets the name of the Category.
 
Categoryoperator= (const Category &other)
 Assignment operator.
 
void setDisplayName (const QString &name)
 Sets the display name of the Category.
 
void setId (const QString &)
 Sets the id of the Category.
 
void setName (const QString &name)
 Sets the name of the Category.
 

Detailed Description

Represents a single content category.

Constructor & Destructor Documentation

◆ Category() [1/2]

Attica::Category::Category ( )

Creates an empty Category.

◆ Category() [2/2]

Attica::Category::Category ( const Category other)

Copy constructor.

Parameters
otherthe Category to copy from

◆ ~Category()

Attica::Category::~Category ( )

Destructor.

Member Function Documentation

◆ displayName()

QString Attica::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

◆ id()

QString Attica::Category::id ( ) const

Gets the id of the Category.

The id uniquely identifies a Category with the OCS API.

Returns
the id

◆ isValid()

bool Attica::Category::isValid ( ) const

Checks whether this Category has an id.

Returns
true if an id has been set, false otherwise

◆ name()

QString Attica::Category::name ( ) const

Gets the name of the Category.

Returns
the name

◆ operator=()

Category & Attica::Category::operator= ( const Category other)

Assignment operator.

Parameters
otherthe Category to assign from
Returns
pointer to this Category

◆ setDisplayName()

void Attica::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
namethe new name
Since
5.31

◆ setId()

void Attica::Category::setId ( const QString &  )

Sets the id of the Category.

The id uniquely identifies a Category with the OCS API.

Parameters
idthe new id

◆ setName()

void Attica::Category::setName ( const QString &  name)

Sets the name of the Category.

Parameters
namethe new name