Attica::Event Class Reference

#include <Attica/Event>

Public Types
typedef QList< Event >	List

Public Member Functions
	Event ()
	Event (const Event &other)
	~Event ()
void	addExtendedAttribute (const QString &key, const QString &value)
QString	city () const
QString	country () const
QString	description () const
QDate	endDate () const
QString	extendedAttribute (const QString &key) const
QMap< QString, QString >	extendedAttributes () const
QUrl	homepage () const
QString	id () const
bool	isValid () const
qreal	latitude () const
qreal	longitude () const
QString	name () const
Event &	operator= (const Event &other)
void	setCity (const QString &city)
void	setCountry (const QString &country)
void	setDescription (const QString &description)
void	setEndDate (const QDate &endDate)
void	setHomepage (const QUrl &homepage)
void	setId (const QString &id)
void	setLatitude (qreal latitude)
void	setLongitude (qreal longitude)
void	setName (const QString &name)
void	setStartDate (const QDate &startDate)
void	setUser (const QString &user)
QDate	startDate () const
QString	user () const

Detailed Description

Represents a single event.

Definition at line 27 of file event.h.

Member Typedef Documentation

List

QList<Event> Attica::Event::List

Definition at line 30 of file event.h.

Constructor & Destructor Documentation

Event() [1/2]

Event::Event

(

)

Creates an empty Event.

Definition at line 36 of file event.cpp.

Event() [2/2]

Event::Event

(

const Event &

other

)

Copy constructor.

Parameters

other

the Event to copy from

Definition at line 41 of file event.cpp.

~Event()

Event::~Event

(

)

Destructor.

Definition at line 52 of file event.cpp.

Member Function Documentation

addExtendedAttribute()

void Event::addExtendedAttribute	(	const QString &	key,
		const QString &	value )

Add an attribute that is not included in the basis set of attributes exposed by the Event class.

If the attribute already exists it gets overwritten.

Parameters

key	the key of the attribute
value	the value of the attribute

Definition at line 166 of file event.cpp.

city()

QString Event::city

(

)

const

Gets the city where the Event takes place.

Returns

the city

Definition at line 161 of file event.cpp.

country()

QString Event::country

(

)

const

Gets the country where the Event takes place.

Returns

the country

Definition at line 151 of file event.cpp.

description()

QString Event::description

(

)

const

Gets the description of the Event.

Returns

the description

Definition at line 81 of file event.cpp.

endDate()

QDate Event::endDate

(

)

const

Gets the start date of the Event.

Returns

the end date

Definition at line 111 of file event.cpp.

extendedAttribute()

QString Event::extendedAttribute

(

const QString &

key

)

const

Get an attribute that is not included in the basis set of attributes exposed by the Event class.

Parameters

key	the key of the attribute

Returns

the value of the attribute with the specified key, or an empty string, if the key has not been found

Definition at line 171 of file event.cpp.

extendedAttributes()

QMap< QString, QString > Event::extendedAttributes

(

)

const

Get all attributes that are not included in the basis set of attributes exposed by the Event class.

Returns

the attribute mappings

Definition at line 176 of file event.cpp.

homepage()

QUrl Event::homepage

(

)

const

Gets the homepage of the Event.

Returns

the homepage

Definition at line 141 of file event.cpp.

id()

QString Event::id

(

)

const

Gets the id of the Event.

The id uniquely identifies a Event with the OCS API.

Returns

the id

Definition at line 61 of file event.cpp.

isValid()

bool Event::isValid

(

)

const

Checks whether this Event has an id.

Returns

true if an id has been set, false otherwise

Definition at line 181 of file event.cpp.

latitude()

qreal Event::latitude

(

)

const

Gets the latitude of the position the Event takes place.

Returns

the latitude

Definition at line 121 of file event.cpp.

longitude()

qreal Event::longitude

(

)

const

Gets the longitude of the position the Event takes place.

Returns

the latitude

Definition at line 131 of file event.cpp.

name()

QString Event::name

(

)

const

Gets the name of the Event.

Returns

the name

Definition at line 71 of file event.cpp.

operator=()

Event & Event::operator=

(

const Event &

other

)

Assignment operator.

Parameters

other

the Event to assign from

Returns

pointer to this Event

Definition at line 46 of file event.cpp.

setCity()

void Event::setCity

(

const QString &

city

)

Sets the city where the Event takes place.

Parameters

city	the new city

Definition at line 156 of file event.cpp.

setCountry()

void Event::setCountry

(

const QString &

country

)

Sets the country where the Event takes place.

Parameters

country

the new country

Definition at line 146 of file event.cpp.

setDescription()

void Event::setDescription

(

const QString &

description

)

Sets the description of the Event.

Parameters

description

the new description

Definition at line 76 of file event.cpp.

setEndDate()

void Event::setEndDate

(

const QDate &

endDate

)

Sets the end date of the Event.

Parameters

endDate

the end date

Definition at line 106 of file event.cpp.

setHomepage()

void Event::setHomepage

(

const QUrl &

homepage

)

Sets the homepage of the Event.

Parameters

homepage

the new homepage

Definition at line 136 of file event.cpp.

setId()

void Event::setId

(

const QString &

id

)

Sets the id of the Event.

The id uniquely identifies a Event with the OCS API.

Parameters

id	the new id

Definition at line 56 of file event.cpp.

setLatitude()

void Event::setLatitude

(

qreal

latitude

)

Sets the latitude of the position the Event takes place.

Parameters

latitude

the new latitude

Definition at line 116 of file event.cpp.

setLongitude()

void Event::setLongitude

(

qreal

longitude

)

Sets the longitude of the position the Event takes place.

Parameters

longitude

the new latitude

Definition at line 126 of file event.cpp.

setName()

void Event::setName

(

const QString &

name

)

Sets the name of the Event.

Parameters

name	the new name

Definition at line 66 of file event.cpp.

setStartDate()

void Event::setStartDate

(

const QDate &

startDate

)

Sets the start date of the Event.

Parameters

startDate

the start date

Definition at line 96 of file event.cpp.

setUser()

void Event::setUser

(

const QString &

user

)

Sets the id of the user bound to the Event.

Parameters

user	the new user id

Definition at line 86 of file event.cpp.

startDate()

QDate Event::startDate

(

)

const

Gets the start date of the Event.

Returns

the start date

Definition at line 101 of file event.cpp.

user()

QString Event::user

(

)

const

Gets the id of the user bound to the Event.

Returns

the user id

Definition at line 91 of file event.cpp.

---

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

• event.h
• event.cpp