KCal::Calendar Class Reference
This is the main "calendar" object class for KOrganizer. More...
#include <calendar.h>
Inherits QObject, KCal::CustomProperties, and KCal::IncidenceBase::Observer.
Inherited by KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources.
Signals
Public Member Functions
- Calendar (const QString &timeZoneId)
- virtual void close ()=0
- virtual void save ()=0
- virtual bool isSaving ()
- const Person & getOwner () const
- void setOwner (const Person &owner)
- void setTimeZoneId (const QString &)
- QString timeZoneId () const
- void setLocalTime ()
- bool isLocalTime () const
- virtual bool addIncidence (Incidence *)
- virtual bool deleteIncidence (Incidence *)
- virtual Incidence::List incidences ()
- virtual Incidence::List incidences (const QDate &qdt)
- virtual Incidence::List rawIncidences ()
- QStringList incidenceCategories ()
- virtual bool addEvent (Event *)=0
- virtual void deleteEvent (Event *)=0
- virtual Event * event (const QString &UniqueStr)=0
- Event::List events (const QDate &date, bool sorted=false)
- Event::List events (const QDateTime &qdt)
- Event::List events (const QDate &start, const QDate &end, bool inclusive=false)
- virtual Event::List events (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
- virtual Event::List rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
- virtual bool addTodo (Todo *todo)=0
- virtual void deleteTodo (Todo *)=0
- virtual Todo::List todos (TodoSortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
- virtual Todo * todo (const QString &uid)=0
- virtual Todo::List todos (const QDate &date)
- virtual Todo::List rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
- virtual Todo::List rawTodosForDate (const QDate &date)=0
- virtual bool addJournal (Journal *)=0
- virtual void deleteJournal (Journal *)=0
- virtual Journal * journal (const QString &uid)=0
- virtual Journal::List journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
- virtual Journal::List journals (const QDate &date)
- virtual Journal::List rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
- virtual Journal::List rawJournalsForDate (const QDate &date)=0
- Incidence * incidence (const QString &uid)
- Incidence * incidenceFromSchedulingID (const QString &uid)
- virtual void setupRelations (Incidence *)
- virtual void removeRelations (Incidence *)
- void setFilter (CalFilter *)
- CalFilter * filter ()
- virtual Alarm::List alarms (const QDateTime &from, const QDateTime &to)=0
- void registerObserver (Observer *)
- void unregisterObserver (Observer *)
- void setModified (bool)
- bool isModified () const
- void setLoadedProductId (const QString &)
- QString loadedProductId ()
- virtual bool beginChange (Incidence *)
- virtual bool endChange (Incidence *)
- Incidence * dissociateOccurrence (Incidence *incidence, QDate date, bool single=true)
- virtual Event::List rawEventsForDate (const QDateTime &qdt)=0
- virtual Event::List rawEventsForDate (const QDate &date, bool sorted=false)=0
- virtual Event::List rawEvents (const QDate &start, const QDate &end, bool inclusive=false)=0
Static Public Member Functions
- static Event::List sortEvents (Event::List *eventList, EventSortField sortField, SortDirection sortDirection)
- static Todo::List sortTodos (Todo::List *todoList, TodoSortField sortField, SortDirection sortDirection)
- static Journal::List sortJournals (Journal::List *journalList, JournalSortField sortField, SortDirection sortDirection)
- static Incidence::List mergeIncidenceList (const Event::List &, const Todo::List &, const Journal::List &)
Protected Member Functions
- void incidenceUpdated (IncidenceBase *)
- virtual void doSetTimeZoneId (const QString &)
- void notifyIncidenceAdded (Incidence *)
- void notifyIncidenceChanged (Incidence *)
- void notifyIncidenceDeleted (Incidence *)
- void setObserversEnabled (bool enabled)
Detailed Description
This is the main "calendar" object class for KOrganizer.It holds information like all appointments/events, user information, etc. etc. one calendar is associated with each CalendarView (
- See also:
- calendarview.h ). This is an abstract base class defining the interface to a calendar. It is implemented by subclasses like
CalendarLocal, which use different methods to store and access the data.
Member Function Documentation
|
Clears out the current calendar, freeing all used memory etc.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Sync changes in memory to persistant storage.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return the owner of the calendar's full name.
|
|
Set the owner of the calendar. Should be owner's full name. |
|
Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal values).
|
|
Return time zone id.
|
|
Use local time, not UTC or a time zone.
|
|
Return whether local time is being used.
|
|
Sort eventList according to sortField.
|
|
Sort todoList according to sortField.
|
|
Sort journalList according to sortField.
|
|
Add an incidence to calendar.
Reimplemented in KCal::CalendarResources. |
|
Delete an incidence from calendar.
|
|
Return filtered list of all incidences of this calendar.
|
|
Return unfiltered list of all incidences of this calendar.
|
|
Return a list of all categories used in this calendar.
|
|
Adds a Event to this calendar object.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Delete event from calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Retrieves an event on the basis of the unique string ID.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Builds and then returns a list of all events that match for the date specified. useful for dayView, etc. etc. The calendar filter is applied. |
|
Get events, which occur on the given date. The calendar filter is applied. |
|
Get events in a range of dates. If inclusive is set to true, only events are returned, which are completely included in the range. The calendar filter is applied. |
|
Return filtered list of all events sorted according to sortField.
|
|
Return unfiltered list of all events in calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Add a todo to the todolist.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Remove a todo from the todolist.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return filtered list of todos.
|
|
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Returns list of todos due on the specified date.
|
|
Return unfiltered list of todos.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return unfiltered list of todos.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Add a Journal entry to calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Remove a journal entry from the calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return Journal with given UID.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return list of all Journal entries.
|
|
Returns list of journals for the specified date.
|
|
Return unfiltered list of all journals in calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return unfiltered list of journals for a given date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Searches all incidence types for an incidence with this unique string identifier, returns a pointer or null.
|
|
Searches all events and todos for an incidence with this scheduling ID. Returns a pointer or null. |
|
Setup relations for an incidence.
|
|
Remove all relations to an incidence.
|
|
Set calendar filter, which filters events for the events() functions. The Filter object is owned by the caller. |
|
Return calendar filter.
|
|
Return all alarms, which ocur in the given time interval.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return whether the calendar was modified since opening / saving.
|
|
Set product id returned by loadedProductId(). This function is only useful for the calendar loading code. |
|
Return product id taken from file that has been loaded. Returns QString::null, if no calendar has been loaded. |
|
Merge lists of events, todos and journals to a list of incidences.
|
|
Dissociate an incidence from a recurring incidence. By default, only one single event for the given date will be dissociated and returned. If single == false, the recurrence will be split at date, the old incidence will have its recurrence ending at date and the new incidence (return value) will have all recurrences past the date. |
|
The observer interface. So far not implemented. Reimplemented in KCal::CalendarNull. |
|
Get unfiltered events, which occur on the given date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Get unfiltered events, which occur on the given date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Get events in a range of dates. If inclusive is set to true, only events are returned, which are completely included in the range. Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
let the subclasses of KCal::Calendar set the time zone
Reimplemented in KCal::CalendarResources. |
The documentation for this class was generated from the following files:
- calendar.h
- calendar.cpp