Attica::Event

Attica::Event Class Reference

#include <event.h>

Public Types

typedef QList< EventList
 

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, QStringextendedAttributes () const
 
QUrl homepage () const
 
QString id () const
 
bool isValid () const
 
qreal latitude () const
 
qreal longitude () const
 
QString name () const
 
Eventoperator= (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 26 of file event.h.

Constructor & Destructor Documentation

Event::Event ( )

Creates an empty Event.

Definition at line 36 of file event.cpp.

Event::Event ( const Event other)

Copy constructor.

Parameters
otherthe Event to copy from

Definition at line 41 of file event.cpp.

Event::~Event ( )

Destructor.

Definition at line 52 of file event.cpp.

Member Function Documentation

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
keythe key of the attribute
valuethe value of the attribute

Definition at line 166 of file event.cpp.

QString Event::city ( ) const

Gets the city where the Event takes place.

Returns
the city

Definition at line 161 of file event.cpp.

QString Event::country ( ) const

Gets the country where the Event takes place.

Returns
the country

Definition at line 151 of file event.cpp.

QString Event::description ( ) const

Gets the description of the Event.

Returns
the description

Definition at line 81 of file event.cpp.

QDate Event::endDate ( ) const

Gets the start date of the Event.

Returns
the end date

Definition at line 111 of file event.cpp.

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
keythe 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.

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.

QUrl Event::homepage ( ) const

Gets the homepage of the Event.

Returns
the homepage

Definition at line 141 of file event.cpp.

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.

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.

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.

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.

QString Event::name ( ) const

Gets the name of the Event.

Returns
the name

Definition at line 71 of file event.cpp.

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

Assignment operator.

Parameters
otherthe Event to assign from
Returns
pointer to this Event

Definition at line 46 of file event.cpp.

void Event::setCity ( const QString city)

Sets the city where the Event takes place.

Parameters
citythe new city

Definition at line 156 of file event.cpp.

void Event::setCountry ( const QString country)

Sets the country where the Event takes place.

Parameters
countrythe new country

Definition at line 146 of file event.cpp.

void Event::setDescription ( const QString description)

Sets the description of the Event.

Parameters
descriptionthe new description

Definition at line 76 of file event.cpp.

void Event::setEndDate ( const QDate endDate)

Sets the end date of the Event.

Parameters
endDatethe end date

Definition at line 106 of file event.cpp.

void Event::setHomepage ( const QUrl homepage)

Sets the homepage of the Event.

Parameters
homepagethe new homepage

Definition at line 136 of file event.cpp.

void Event::setId ( const QString id)

Sets the id of the Event.

The id uniquely identifies a Event with the OCS API.

Parameters
idthe new id

Definition at line 56 of file event.cpp.

void Event::setLatitude ( qreal  latitude)

Sets the latitude of the position the Event takes place.

Parameters
latitudethe new latitude

Definition at line 116 of file event.cpp.

void Event::setLongitude ( qreal  longitude)

Sets the longitude of the position the Event takes place.

Parameters
longitudethe new latitude

Definition at line 126 of file event.cpp.

void Event::setName ( const QString name)

Sets the name of the Event.

Parameters
namethe new name

Definition at line 66 of file event.cpp.

void Event::setStartDate ( const QDate startDate)

Sets the start date of the Event.

Parameters
startDatethe start date

Definition at line 96 of file event.cpp.

void Event::setUser ( const QString user)

Sets the id of the user bound to the Event.

Parameters
userthe new user id

Definition at line 86 of file event.cpp.

QDate Event::startDate ( ) const

Gets the start date of the Event.

Returns
the start date

Definition at line 101 of file event.cpp.

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 9 2020 23:00:29 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.