KCal::ResourceKABC Class Reference

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

#include <resourcekabc.h>

Inherits KCal::ResourceCalendar.

List of all members.

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 (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
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 (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Todo::List rawTodosForDate (const QDate &date)
virtual bool addJournal (Journal *)
void deleteJournal (Journal *)
virtual Journal * journal (const QString &uid)
Journal::List rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Journal::List rawJournalsForDate (const QDate &date)
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 ()
bool doLoad ()
bool doSave ()

Friends

class ResourceKABCConfig

Detailed Description

Resource providing birthdays and anniversaries as events.

Member Function Documentation

bool ResourceKABC::isSaving ( ) [virtual]

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

Reimplemented from KCal::ResourceCalendar.

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

Return object for locking the resource.

Implements KCal::ResourceCalendar.

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

Add Event to calendar.

Implements KCal::ResourceCalendar.

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

deletes an event from this calendar.

Implements KCal::ResourceCalendar.

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

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

Implements KCal::ResourceCalendar.

Event::List ResourceKABC::rawEvents	(	EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)	`[virtual]`

Return unfiltered list of all events in calendar.

Implements KCal::ResourceCalendar.

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.

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

Get unfiltered events for date qdt.

Implements KCal::ResourceCalendar.

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.

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

Add a todo to the todolist.

Implements KCal::ResourceCalendar.

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

Remove a todo from the todolist.

Implements KCal::ResourceCalendar.

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.

Todo::List ResourceKABC::rawTodos	(	TodoSortField	sortField = `TodoSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)	`[virtual]`

Return list of all todos.

Implements KCal::ResourceCalendar.

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

Returns list of todos due on the specified date.

Implements KCal::ResourceCalendar.

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

Add a Journal entry to calendar.

Implements KCal::ResourceCalendar.

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

Remove journal from the calendar.

Implements KCal::ResourceCalendar.

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

Return Journal with given UID.

Implements KCal::ResourceCalendar.

Journal::List ResourceKABC::rawJournals	(	JournalSortField	sortField = `JournalSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)	`[virtual]`