KCal::ResourceKABC

KCal::ResourceKABC Class Reference

Resource providing birthdays and anniversaries as events. More...

#include <resourcekabc.h>

Inheritance diagram for KCal::ResourceKABC:

[legend]Collaboration diagram for KCal::ResourceKABC:


Public Member Functions
	ResourceKABC (const KConfig *)
void	readConfig (const KConfig *config)
void	writeConfig (KConfig *config)
void	setAlarm (bool)
bool	alarm ()
void	setAlarmDays (int)
int	alarmDays ()
bool	isSaving ()
KABC::Lock *	lock ()
bool	addEvent (Event *anEvent)
void	deleteEvent (Event *)
Event *	event (const QString &UniqueStr)
Event::List	rawEvents ()
Event::List	rawEventsForDate (const QDate &date, bool sorted=false)
Event::List	rawEventsForDate (const QDateTime &qdt)
Event::List	rawEvents (const QDate &start, const QDate &end, bool inclusive=false)
bool	addTodo (Todo *todo)
void	deleteTodo (Todo *)
Todo *	todo (const QString &uid)
Todo::List	rawTodos ()
Todo::List	rawTodosForDate (const QDate &date)
virtual bool	addJournal (Journal *)
void	deleteJournal (Journal *)
virtual Journal *	journal (const QDate &)
virtual Journal *	journal (const QString &UID)
Journal::List	journals ()
Alarm::List	alarms (const QDateTime &from, const QDateTime &to)
Alarm::List	alarmsTo (const QDateTime &to)
void	dump () const
void	setTimeZoneId (const QString &tzid)
Protected Member Functions
bool	doOpen ()
void	doClose ()
bool	doLoad ()
bool	doSave ()
Friends
class	ResourceKABCConfig

Detailed Description

Resource providing birthdays and anniversaries as events.

Definition at line 46 of file resourcekabc.h.

Member Function Documentation

bool ResourceKABC::isSaving ( ) [virtual]

Return true if a save operation is still in progress, otherwise return false.

Reimplemented from KCal::ResourceCalendar.
Definition at line 297 of file resourcekabc.cpp.

KABC::Lock * ResourceKABC::lock ( ) [virtual]

Return object for locking the resource.

Implements KCal::ResourceCalendar.
Definition at line 302 of file resourcekabc.cpp.

bool ResourceKABC::addEvent ( Event * anEvent ) [virtual]

Add Event to calendar.

Implements KCal::ResourceCalendar.
Definition at line 316 of file resourcekabc.cpp.

void ResourceKABC::deleteEvent ( Event * ) [virtual]

deletes an event from this calendar.

Implements KCal::ResourceCalendar.
Definition at line 321 of file resourcekabc.cpp.

Event * ResourceKABC::event ( const QString & UniqueStr ) [virtual]

Retrieves an event on the basis of the unique string ID.

Implements KCal::ResourceCalendar.
Definition at line 326 of file resourcekabc.cpp.
References KCal::CalendarLocal::event().

Event::List ResourceKABC::rawEvents ( ) [virtual]

Return unfiltered list of all events in calendar.

Implements KCal::ResourceCalendar.
Definition at line 348 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawEvents().

Event::List ResourceKABC::rawEventsForDate ( const QDate & date,

bool sorted = false

) [virtual]

Builds and then returns a list of all events that match for the date specified.
useful for dayView, etc. etc.
Implements KCal::ResourceCalendar.
Definition at line 331 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawEventsForDate().

Event::List ResourceKABC::rawEventsForDate ( const QDateTime & qdt ) [virtual]

Get unfiltered events for date qdt.

Implements KCal::ResourceCalendar.
Definition at line 343 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawEventsForDate().

Event::List ResourceKABC::rawEvents ( const QDate & start,

const QDate & end,

bool inclusive = false

) [virtual]

Get unfiltered events in a range of dates.
If inclusive is set to true, only events are returned, which are completely included in the range.
Implements KCal::ResourceCalendar.
Definition at line 337 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawEvents().

bool ResourceKABC::addTodo ( Todo * todo ) [virtual]

Add a todo to the todolist.

Implements KCal::ResourceCalendar.
Definition at line 353 of file resourcekabc.cpp.

void ResourceKABC::deleteTodo ( Todo * ) [virtual]

Remove a todo from the todolist.

Implements KCal::ResourceCalendar.
Definition at line 358 of file resourcekabc.cpp.

Todo * ResourceKABC::todo ( const QString & uid ) [virtual]

Searches todolist for an event with this unique string identifier, returns a pointer or null.

Implements KCal::ResourceCalendar.
Definition at line 368 of file resourcekabc.cpp.
References KCal::CalendarLocal::todo().

Todo::List ResourceKABC::rawTodos ( ) [virtual]

Return list of all todos.

Implements KCal::ResourceCalendar.
Definition at line 363 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawTodos().

Todo::List ResourceKABC::rawTodosForDate ( const QDate & date ) [virtual]

Returns list of todos due on the specified date.

Implements KCal::ResourceCalendar.
Definition at line 373 of file resourcekabc.cpp.
References KCal::CalendarLocal::rawTodosForDate().

bool ResourceKABC::addJournal ( Journal * ) [virtual]

Add a Journal entry to calendar.

Implements KCal::ResourceCalendar.
Definition at line 379 of file resourcekabc.cpp.

void ResourceKABC::deleteJournal ( Journal * ) [virtual]

Remove journal from the calendar.

Implements KCal::ResourceCalendar.
Definition at line 384 of file resourcekabc.cpp.

Journal * ResourceKABC::journal ( const QDate & ) [virtual]

Return Journal for given date.

Implements KCal::ResourceCalendar.
Definition at line 388 of file resourcekabc.cpp.
References KCal::CalendarLocal::journal().

Journal * ResourceKABC::journal ( const QString & UID ) [virtual]

Return Journal with given UID.

Implements KCal::ResourceCalendar.
Definition at line 395 of file resourcekabc.cpp.
References KCal::CalendarLocal::journal().

Journal::List ResourceKABC::journals ( ) [virtual]

Return list of all Journals stored in calendar.

Implements KCal::ResourceCalendar.
Definition at line 400 of file resourcekabc.cpp.
References KCal::CalendarLocal::journals().

Alarm::List ResourceKABC::alarms ( const QDateTime & from,

const QDateTime & to

) [virtual]

Return all alarms, which ocur in the given time interval.

Implements KCal::ResourceCalendar.
Definition at line 411 of file resourcekabc.cpp.
References KCal::CalendarLocal::alarms().

Alarm::List ResourceKABC::alarmsTo ( const QDateTime & to ) [virtual]

Return all alarms, which ocur before given date.

Implements KCal::ResourceCalendar.
Definition at line 406 of file resourcekabc.cpp.
References KCal::CalendarLocal::alarmsTo().

void ResourceKABC::setTimeZoneId ( const QString & tzid ) [virtual]

Set time zone id used by this resource, e.g.
"Europe/Berlin".
Implements KCal::ResourceCalendar.
Definition at line 428 of file resourcekabc.cpp.
References KCal::Calendar::setTimeZoneId().

bool ResourceKABC::doLoad ( ) [protected, virtual]

Do the actual loading of the resource data.
Called by load().
Implements KCal::ResourceCalendar.
Definition at line 129 of file resourcekabc.cpp.
References KCal::CalendarLocal::addEvent(), KCal::Recurrence::addYearlyNum(), KCal::Incidence::clearAlarms(), KCal::CalendarLocal::close(), KCal::Incidence::newAlarm(), KCal::Incidence::recurrence(), KCal::Incidence::setCategories(), KCal::Event::setDtEnd(), KCal::Incidence::setDtStart(), KCal::Alarm::setEnabled(), KCal::IncidenceBase::setFloats(), KCal::Event::setHasEndDate(), KCal::Incidence::setReadOnly(), KCal::Recurrence::setRecurStart(), KCal::Alarm::setStartOffset(), KCal::Incidence::setSummary(), KCal::Alarm::setText(), KCal::Alarm::setTime(), KCal::Event::setTransparency(), and KCal::Recurrence::setYearly().

bool ResourceKABC::doSave ( ) [protected, virtual]

Do the actual saving of the resource data.
Called by save().
Implements KCal::ResourceCalendar.
Definition at line 291 of file resourcekabc.cpp.

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

libkcal Library API Documentation

KCal::ResourceKABC Class Reference

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation