Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# DateBookAccess Class Reference
[qpepim module]

The DateBookAccess class provides a safe API for accessing PimEvents. More...

`#include <qtopia/pim/datebookaccess.h>`

List of all member functions.

## Public Members

- DateBookAccess ()
- ~DateBookAccess ()
- bool editSupported () const
- void updateEvent ( const PimEvent & event )
- void removeEvent ( const PimEvent & ev )
- void addEvent ( const PimEvent & ev )
- void addException ( const PimEvent & event, const QDate & date, const PimEvent & exception )
- void addException ( const PimEvent & event, const QDate & date )
- void removeException ( const PimEvent & event, const PimEvent & exception )
- void removeException ( const PimEvent & event, const QDate & date )
- void removeAllExceptions ( const PimEvent & event )
- PimEvent eventForId ( const QUuid & u, bool * ok = 0 ) const

## Signals

- void dateBookUpdated ()

## Detailed Description

The DateBookAccess class provides a safe API for accessing PimEvents.

DateBookAccess provides a safe API for accessing PimEvents stored by Qtopia's Datebook application. DateBookAccess tries to keep the Datebook application in sync with modifications, and alerts the user of the library when modifications ahve been made by other applications.

See also Qtopia PIM Library.

## Member Function Documentation

### DateBookAccess::DateBookAccess ()

Constructor.

### DateBookAccess::~DateBookAccess ()

Cleans up the the DataBookAccess.

### void DateBookAccess::addEvent ( const PimEvent & ev )

If supported will assign a new unique ID to ev and add the event to the pim data.

Adding event requires the Events service to be available.

If the event is added correctly, an addedEvent(int,PimEvent) message will be sent to the QPE/PIM channel. The event in this message can be used to determine the assigned ID.

### void DateBookAccess::addException ( const PimEvent & event, const QDate & date, const PimEvent & exception )

Adds an exception to the repeat partern of the event. event will be suppressed from occuring on the date given, instead will occur as described by exception. The date the exception occurs on need not be the same as the date given.

See also removeException() and removeAllExceptions().

### void DateBookAccess::addException ( const PimEvent & event, const QDate & date )

Adds an exception to the repeat partern of the event. event will be suppressed from occuring on the date given.

See also removeException() and removeAllExceptions().

### void DateBookAccess::dateBookUpdated ()`[signal]`

Emitted whenever the datebook is updated.

### bool DateBookAccess::editSupported () const

Returns TRUE if it is possible to add, remove and update events in the pim data. Otherwise returns FALSE.

Adding, removing and updating events requires the Events service to be available

### PimEvent DateBookAccess::eventForId ( const QUuid & u, bool * ok = 0 ) const

If there exists an event with the uid u, return that event. Returns a null event if otherwise.

If ok is non-null, *ok is set to TRUE if the event is found, and FALSE if the event is not found.

### void DateBookAccess::removeAllExceptions ( const PimEvent & event )

Removes all exceptions for the repeat pattern of event. The exceptions will be replaced by the normal occurance for the repeat pattern of event.

See also removeException() and addException().

### void DateBookAccess::removeEvent ( const PimEvent & ev )

If supported will remove event ev from the pim data.

Removing events requires the Events service to be available.

### void DateBookAccess::removeException ( const PimEvent & event, const PimEvent & exception )

Removes the exception for the repeat patern of event. Does not compare the data for the exception passed, rather matches the uid for the exception passed and determines if it matches an event described as an exception to the repeat pattern of the event. The exception event will be replaced by a normal occurance for the repeat pattern of event.

If no exception can be matched, then this function will have no effect.

See also addException() and removeAllExceptions().

### void DateBookAccess::removeException ( const PimEvent & event, const QDate & date )

Removes the exception given by date for the repeat pattern of event. The exception event will be replaced by a normal occurance for the repeat pattern of event.

If there is no exception for the repeat pattern of event on the \date passed, then this function will have no effect.

See also addException() and removeAllExceptions().

### void DateBookAccess::updateEvent ( const PimEvent & event )

If supported will update event in the pim data.

Updating events requires the Events service to be available.

This file is part of the Qtopia platform, copyright © 1995-2004 Trolltech, all rights reserved.