OEvent Class Reference

This is the container for all Events. container for events. More...

#include <oevent.h>

Inheritance diagram for OEvent:

[legend]Collaboration diagram for OEvent:


Public Types
typedef QValueList< OEvent >	ValueList
enum	RecordFields { FUid = Qtopia::UID_ID, FCategories = Qtopia::CATEGORY_ID, FDescription = 0, FLocation, FType, FAlarm, FSound, FRType, FRWeekdays, FRPosition, FRFreq, FRHasEndDate, FREndDate, FRCreated, FRExceptions, FStart, FEnd, FNote, FTimeZone, FRecParent, FRecChildren }
	RecordFields contain possible attributes used in the Results of toMap().. More...
Public Member Functions
	OEvent (int uid=0)
	Start with an Empty OEvent.
	OEvent (const OEvent &)
	copy c'tor
	OEvent (const QMap< int, QString > map)
	Create OEvent, initialized by map.
	~OEvent ()
OEvent &	operator= (const OEvent &)
QString	description () const
void	setDescription (const QString &description)
QString	location () const
void	setLocation (const QString &loc)
bool	hasNotifiers () const
OPimNotifyManager &	notifiers () const
ORecur	recurrence () const
void	setRecurrence (const ORecur &)
bool	hasRecurrence () const
QString	note () const
void	setNote (const QString &note)
QDateTime	createdDateTime () const
void	setCreatedDateTime (const QDateTime &dt)
void	setStartDateTime (const QDateTime &)
	set the date to dt.
QDateTime	startDateTime () const
	returns the datetime in the local timeZone
QDateTime	startDateTimeInZone () const
	returns the start datetime in the current zone
void	setEndDateTime (const QDateTime &)
	in current timezone
QDateTime	endDateTime () const
	in current timezone
QDateTime	endDateTimeInZone () const
bool	isMultipleDay () const
bool	isAllDay () const
void	setAllDay (bool isAllDay)
void	setTimeZone (const QString &timeZone)
QString	timeZone () const
virtual bool	match (const QRegExp &) const
QArray< int >	children () const
	For exception to recurrence here is a list of children...
void	setChildren (const QArray< int > &)
void	addChild (int uid)
void	removeChild (int uid)
int	parent () const
	return the parent OEvent
void	setParent (int uid)
QString	toRichText () const
	toRichText summary
QString	toShortText () const
	a small one line summary
QString	type () const
	the name of the Record
QMap< int, QString >	toMap () const
	converts the internal structure to a map
void	fromMap (const QMap< int, QString > &map)
QString	recordField (int) const
	the name for a recordField
bool	loadFromStream (QDataStream &)
	some marshalling and de marshalling code saves the OPimRecord to and from a DataStream
bool	saveToStream (QDataStream &) const
Static Public Member Functions
int	rtti ()

Detailed Description

This is the container for all Events. container for events.

It encapsules all available information for a single Event

Definition at line 39 of file oevent.h.

Member Typedef Documentation

typedef QValueList<OEvent> OEvent::ValueList

Definition at line 41 of file oevent.h.
Referenced by ODateBookAccessBackend_XML::directNonRepeats(), ODateBookAccessBackend_SQL::directNonRepeats(), ODateBookAccessBackend_XML::directRawRepeats(), ODateBookAccessBackend_SQL::directRawRepeats(), ODateBookAccessBackend::effectiveEvents(), ODateBookAccessBackend::effectiveNonRepeatingEvents(), events(), and repeat().

Member Enumeration Documentation

enum OEvent::RecordFields

RecordFields contain possible attributes used in the Results of toMap()..

Enumeration values:

FUid

FCategories

FDescription

FLocation

FType

FAlarm

FSound

FRType

FRWeekdays

FRPosition

FRFreq

FRHasEndDate

FREndDate

FRCreated

FRExceptions

FStart

FEnd

FNote

FTimeZone

FRecParent

FRecChildren

Definition at line 46 of file oevent.h.

Constructor & Destructor Documentation

OEvent::OEvent ( int uid = 0 )

Start with an Empty OEvent.
UID == 0 means that it is empty
Definition at line 71 of file oevent.cpp.

OEvent::OEvent ( const OEvent & )

copy c'tor

Definition at line 75 of file oevent.cpp.

OEvent::OEvent ( const QMap< int, QString > map )

Create OEvent, initialized by map.

See also:
enum RecordFields

Definition at line 81 of file oevent.cpp.
References fromMap().

OEvent::~OEvent ( )

Definition at line 89 of file oevent.cpp.

Member Function Documentation

OEvent & OEvent::operator= ( const OEvent & )

Definition at line 95 of file oevent.cpp.
References data, and OPimRecord::operator=().

QString OEvent::description ( ) const

Definition at line 106 of file oevent.cpp.
Referenced by save().

void OEvent::setDescription ( const QString & description )

Definition at line 109 of file oevent.cpp.
Referenced by fromMap().

QString OEvent::location ( ) const

Definition at line 117 of file oevent.cpp.
Referenced by save().

void OEvent::setLocation ( const QString & loc )

Definition at line 113 of file oevent.cpp.
Referenced by fromMap().

bool OEvent::hasNotifiers ( ) const

Definition at line 129 of file oevent.cpp.
Referenced by save().

OPimNotifyManager & OEvent::notifiers ( ) const

Definition at line 120 of file oevent.cpp.
Referenced by fromMap(), and save().

ORecur OEvent::recurrence ( ) const

Definition at line 138 of file oevent.cpp.
Referenced by save().

void OEvent::setRecurrence ( const ORecur & )

Definition at line 144 of file oevent.cpp.
Referenced by fromMap().

bool OEvent::hasRecurrence ( ) const

Definition at line 151 of file oevent.cpp.
Referenced by ODateBookAccessBackend_XML::add(), and save().

QString OEvent::note ( ) const

Definition at line 155 of file oevent.cpp.
Referenced by save().

void OEvent::setNote ( const QString & note )

Definition at line 158 of file oevent.cpp.

QDateTime OEvent::createdDateTime ( ) const

Definition at line 162 of file oevent.cpp.

void OEvent::setCreatedDateTime ( const QDateTime & dt )

Definition at line 165 of file oevent.cpp.

void OEvent::setStartDateTime ( const QDateTime & )

set the date to dt.
dt is the QDateTime in localtime
Definition at line 181 of file oevent.cpp.
Referenced by fromMap().

QDateTime OEvent::startDateTime ( ) const

returns the datetime in the local timeZone

Definition at line 169 of file oevent.cpp.
Referenced by fromMap(), OEffectiveEvent::OEffectiveEvent(), and save().

QDateTime OEvent::startDateTimeInZone ( ) const

returns the start datetime in the current zone

Definition at line 174 of file oevent.cpp.
References OTimeZone::current(), OTimeZone::timeZone(), and OTimeZone::toDateTime().

void OEvent::setEndDateTime ( const QDateTime & )

in current timezone

Definition at line 201 of file oevent.cpp.
Referenced by fromMap().

QDateTime OEvent::endDateTime ( ) const

in current timezone

Definition at line 185 of file oevent.cpp.
Referenced by OEffectiveEvent::OEffectiveEvent(), and save().

QDateTime OEvent::endDateTimeInZone ( ) const

Definition at line 194 of file oevent.cpp.
References OTimeZone::current(), OTimeZone::timeZone(), and OTimeZone::toDateTime().

bool OEvent::isMultipleDay ( ) const

Definition at line 205 of file oevent.cpp.

bool OEvent::isAllDay ( ) const

Definition at line 208 of file oevent.cpp.
Referenced by fromMap(), and save().

void OEvent::setAllDay ( bool isAllDay )

Definition at line 211 of file oevent.cpp.
Referenced by fromMap().

void OEvent::setTimeZone ( const QString & timeZone )

Definition at line 216 of file oevent.cpp.
Referenced by fromMap().

QString OEvent::timeZone ( ) const

Definition at line 220 of file oevent.cpp.
References QString::fromLatin1().
Referenced by fromMap(), and save().

bool OEvent::match ( const QRegExp & ) const [virtual]

Reimplemented from Qtopia::Record.
Definition at line 224 of file oevent.cpp.

QArray< int > OEvent::children ( ) const

For exception to recurrence here is a list of children...

Definition at line 510 of file oevent.cpp.
Referenced by save().

void OEvent::setChildren ( const QArray< int > & )

Definition at line 515 of file oevent.cpp.

void OEvent::addChild ( int uid )

Definition at line 522 of file oevent.cpp.
Referenced by fromMap().

void OEvent::removeChild ( int uid )

Definition at line 533 of file oevent.cpp.

int OEvent::parent ( ) const

return the parent OEvent

Definition at line 503 of file oevent.cpp.
Referenced by save().

void OEvent::setParent ( int uid )

Definition at line 506 of file oevent.cpp.
Referenced by fromMap().

QString OEvent::toRichText ( ) const [virtual]

toRichText summary

Implements OPimRecord.
Definition at line 247 of file oevent.cpp.
References description(), Qtopia::escapeString(), QString::replace(), and QObject::tr().

QString OEvent::toShortText ( ) const [virtual]

a small one line summary

Implements OPimRecord.
Definition at line 304 of file oevent.cpp.
References description(), and QString::number().

QString OEvent::type ( ) const [virtual]

the name of the Record

Implements OPimRecord.
Definition at line 319 of file oevent.cpp.
References QString::fromLatin1().

QMap< int, QString > OEvent::toMap ( ) const [virtual]

converts the internal structure to a map

Implements OPimRecord.
Definition at line 374 of file oevent.cpp.
References QArray::count(), OPimNotify::dateTime(), description(), FAlarm, FCategories, FDescription, FEnd, FLocation, FNote, FRCreated, FRecChildren, FRecParent, FREndDate, FRExceptions, FRFreq, FRHasEndDate, OTimeZone::fromUTCDateTime(), FRPosition, FRType, FRWeekdays, FSound, FStart, FTimeZone, FType, FUid, QMap::insert(), QString::number(), QDateTime::secsTo(), OPimAlarm::sound(), OTimeZone::toDateTime(), and ORecur::toMap().
Referenced by ODateBookAccessBackend_SQL::add().

void OEvent::fromMap ( const QMap< int, QString > & map )

Definition at line 424 of file oevent.cpp.
References OPimNotifyManager::add(), addChild(), QDateTime::addSecs(), QValueList::begin(), QValueList::end(), FAlarm, FCategories, FDescription, FEnd, FLocation, FRCreated, FRecChildren, FRecParent, FREndDate, FRExceptions, FRFreq, FRHasEndDate, OTimeZone::fromUTCDateTime(), FRPosition, FRType, FRWeekdays, FSound, FStart, FTimeZone, FType, FUid, Qtopia::Record::idsFromString(), QMap::insert(), isAllDay(), OPimRecord::isEmpty(), notifiers(), recur(), setAllDay(), Qtopia::Record::setCategories(), setDescription(), setEndDateTime(), setLocation(), setParent(), setRecurrence(), setStartDateTime(), setTimeZone(), OPimRecord::setUid(), QStringList::split(), startDateTime(), timeZone(), OTimeZone::toDateTime(), QDateTime::toString(), and OTimeZone::utc().
Referenced by OEvent().

QString OEvent::recordField ( int ) const [virtual]

the name for a recordField

Implements OPimRecord.
Definition at line 322 of file oevent.cpp.

int OEvent::rtti ( ) [static]

Reimplemented from OPimRecord.
Definition at line 325 of file oevent.cpp.

bool OEvent::loadFromStream ( QDataStream & ) [virtual]

some marshalling and de marshalling code saves the OPimRecord to and from a DataStream

Categories
Reimplemented from OPimRecord.
Definition at line 328 of file oevent.cpp.

bool OEvent::saveToStream ( QDataStream & ) const [virtual]

Reimplemented from OPimRecord.
Definition at line 331 of file oevent.cpp.

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

libopie PIM API Documentation

OEvent Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation