libkcal
KCal::CalendarLocal Class Reference
#include <calendarlocal.h>
Detailed Description
This class provides a calendar stored as a local file.
Definition at line 36 of file calendarlocal.h.
Public Member Functions | |
CalendarLocal (const QString &timeZoneId) | |
bool | load (const QString &fileName, CalFormat *format=0) |
bool | reload (const QString &tz) |
bool | save (const QString &fileName, CalFormat *format=0) |
void | close () |
void | save () |
bool | addEvent (Event *event) |
bool | deleteEvent (Event *event) |
void | deleteAllEvents () |
Event * | event (const QString &uid) |
Event::List | rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
bool | addTodo (Todo *todo) |
bool | deleteTodo (Todo *) |
void | deleteAllTodos () |
Todo * | todo (const QString &uid) |
Todo::List | rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Todo::List | rawTodosForDate (const QDate &date) |
bool | addJournal (Journal *) |
bool | deleteJournal (Journal *) |
void | deleteAllJournals () |
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) |
Event::List | rawEventsForDate (const QDate &date, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Event::List | rawEventsForDate (const QDateTime &qdt) |
Event::List | rawEvents (const QDate &start, const QDate &end, bool inclusive=false) |
void | setTimeZoneIdViewOnly (const QString &tz) |
Protected Member Functions | |
void | insertEvent (Event *event) |
void | appendAlarms (Alarm::List &alarms, Incidence *incidence, const QDateTime &from, const QDateTime &to) |
void | appendRecurringAlarms (Alarm::List &alarms, Incidence *incidence, const QDateTime &from, const QDateTime &to) |
Constructor & Destructor Documentation
|
Constructs a new calendar, with variables initialized to sane values.
Definition at line 44 of file calendarlocal.cpp. |
Member Function Documentation
|
Add Event to calendar.
Definition at line 108 of file calendarlocal.cpp. |
|
Add a Journal entry to calendar.
Definition at line 479 of file calendarlocal.cpp. |
|
Add a todo to the todolist.
Definition at line 156 of file calendarlocal.cpp. |
|
Return all alarms, which ocur in the given time interval.
Definition at line 237 of file calendarlocal.cpp. |
|
Return all alarms, which ocur before given date.
Definition at line 232 of file calendarlocal.cpp. |
|
Append alarms of incidence in interval to list of alarms.
Definition at line 259 of file calendarlocal.cpp. |
|
Append alarms of recurring events in interval to list of alarms.
Definition at line 278 of file calendarlocal.cpp. |
|
Clears out the current calendar, freeing all used memory etc. etc. Definition at line 92 of file calendarlocal.cpp. |
|
Deletes all events from this calendar.
Definition at line 136 of file calendarlocal.cpp. |
|
Deletes all journals from this calendar.
Definition at line 510 of file calendarlocal.cpp. |
|
Deletes all todos from this calendar.
Definition at line 188 of file calendarlocal.cpp. |
|
Deletes an event from this calendar.
Definition at line 121 of file calendarlocal.cpp. |
|
Remove a Journal from the calendar.
Definition at line 497 of file calendarlocal.cpp. |
|
Remove a todo from the todolist.
Definition at line 172 of file calendarlocal.cpp. |
|
Retrieves an event on the basis of the unique string ID.
Definition at line 150 of file calendarlocal.cpp. |
|
inserts an event into its "proper place" in the calendar.
Definition at line 353 of file calendarlocal.cpp. |
|
Return Journal with given UID.
Definition at line 522 of file calendarlocal.cpp. |
|
Loads a calendar on disk in vCalendar or iCalendar format into the current calendar. Incidences already present are preserved. If an event of the file to be loaded has the same unique id as an incidence already present the new incidence is ignored. To load a CalendarLocal object from a file without preserving existing incidences call close() before load().
Definition at line 62 of file calendarlocal.cpp. |
|
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. If inclusive is set to false, all events which overlap the range are returned. An event's entire time span is considered in evaluating whether it should be returned. For a non-recurring event, its span is from its start to its end date. For a recurring event, its time span is from its first to its last recurrence. Definition at line 400 of file calendarlocal.cpp. |
|
Return unfiltered list of all events in calendar.
Definition at line 470 of file calendarlocal.cpp. |
|
Get unfiltered events for date qdt.
Definition at line 465 of file calendarlocal.cpp. |
|
Builds and then returns a list of all events that match for the date specified. useful for dayView, etc. etc. Definition at line 366 of file calendarlocal.cpp. |
|
Return list of all journals.
Definition at line 532 of file calendarlocal.cpp. |
|
Get unfiltered journals for a given date.
Definition at line 537 of file calendarlocal.cpp. |
|
Return list of all todos.
Definition at line 201 of file calendarlocal.cpp. |
|
Returns list of todos due on the specified date.
Definition at line 217 of file calendarlocal.cpp. |
|
Reloads the contents of the storage into memory. The associated file name must be known, in other words a previous load() must have been executed.
Definition at line 69 of file calendarlocal.cpp. |
|
Writes out the calendar to disk in the specified format. CalendarLocal takes ownership of the CalFormat object.
Definition at line 80 of file calendarlocal.cpp. |
|
Set the timezone of the calendar to be used for interpreting the events in the calendar. This requires that the calendar is saved first, so the user is asked whether he wants to do that, or keep the timezone as is. Definition at line 552 of file calendarlocal.cpp. |
|
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Definition at line 207 of file calendarlocal.cpp. |
The documentation for this class was generated from the following files: