ODateBookAccess Class Reference

This is the object orientated datebook database. More...

#include <odatebookaccess.h>

Inheritance diagram for ODateBookAccess:

[legend]Collaboration diagram for ODateBookAccess:


Public Member Functions
	ODateBookAccess (ODateBookAccessBackend *=0l, enum Access acc=Random)
	Simple constructor It takes a ODateBookAccessBackend as parent.
	~ODateBookAccess ()
List	rawEvents () const
List	rawRepeats () const
List	nonRepeats () const
OEffectiveEvent::ValueList	effectiveEvents (const QDate &from, const QDate &to) const
OEffectiveEvent::ValueList	effectiveEvents (const QDateTime &start) const
OEffectiveEvent::ValueList	effectiveNonRepeatingEvents (const QDate &from, const QDate &to) const
OEffectiveEvent::ValueList	effectiveNonRepeatingEvents (const QDateTime &start) const

Detailed Description

This is the object orientated datebook database.

It'll use OBackendFactory to query for a backend. All access to the datebook should be done via this class. Make sure to load and save the datebook this is not part of destructing and creating the object

Author:: Holger Freyther, Stefan Eilers

Definition at line 18 of file odatebookaccess.h.

Constructor & Destructor Documentation

ODateBookAccess::ODateBookAccess ( ODateBookAccessBackend * back = 0l,

enum Access ac = Random

)

Simple constructor It takes a ODateBookAccessBackend as parent.
If it is 0 the default implementation will be used!
Parameters:

back The backend to be used or 0 for the default backend

ac What kind of access is intended

Definition at line 11 of file odatebookaccess.cpp.
References OBackendFactory< T >::Default(), and OPimAccessTemplate< OEvent >::setBackEnd().

ODateBookAccess::~ODateBookAccess ( )

Definition at line 20 of file odatebookaccess.cpp.

Member Function Documentation

ODateBookAccess::List ODateBookAccess::rawEvents ( ) const

Returns:
all events available

Definition at line 26 of file odatebookaccess.cpp.

ODateBookAccess::List ODateBookAccess::rawRepeats ( ) const

Returns:
all repeating events

Definition at line 36 of file odatebookaccess.cpp.

ODateBookAccess::List ODateBookAccess::nonRepeats ( ) const

Returns:
all non repeating events

Definition at line 46 of file odatebookaccess.cpp.

OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents ( const QDate & from,

const QDate & to

) const

Returns:
dates in the time span between from and to

Parameters:

from Include all events from...

to Include all events to...

Definition at line 58 of file odatebookaccess.cpp.
References ODateBookAccessBackend::effectiveEvents(), and OEffectiveEvent::ValueList.

OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents ( const QDateTime & start ) const

Returns:
all events at a given datetime

Definition at line 64 of file odatebookaccess.cpp.
References ODateBookAccessBackend::effectiveEvents(), and OEffectiveEvent::ValueList.

OEffectiveEvent::ValueList ODateBookAccess::effectiveNonRepeatingEvents ( const QDate & from,

const QDate & to

) const

Returns:
non repeating dates in the time span between from and to

Parameters:

from Include all events from...

to Include all events to...

Definition at line 73 of file odatebookaccess.cpp.
References ODateBookAccessBackend::effectiveNonRepeatingEvents(), and OEffectiveEvent::ValueList.

OEffectiveEvent::ValueList ODateBookAccess::effectiveNonRepeatingEvents ( const QDateTime & start ) const

Returns:
all non repeating events at a given datetime

Definition at line 79 of file odatebookaccess.cpp.
References ODateBookAccessBackend::effectiveNonRepeatingEvents(), and OEffectiveEvent::ValueList.

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

libopie PIM API Documentation

ODateBookAccess Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation