KCal::Calendar Class Reference
This is the main "calendar" object class for KOrganizer. More...
#include <calendar.h>
Inheritance diagram for KCal::Calendar:

Signals | |
void | calendarChanged () |
void | calendarSaved () |
void | calendarLoaded () |
Public Methods | |
Calendar () | |
Calendar (const QString &timeZoneId) | |
virtual | ~Calendar () |
virtual void | close ()=0 |
virtual void | save ()=0 |
virtual bool | isSaving () |
const QString & | getOwner () const |
void | setOwner (const QString &os) |
const QString & | getEmail () |
void | setEmail (const QString &) |
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 | rawIncidences () |
virtual bool | addEvent (Event *anEvent)=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 () |
virtual Event::List | rawEvents ()=0 |
virtual bool | addTodo (Todo *todo)=0 |
virtual void | deleteTodo (Todo *)=0 |
virtual Todo::List | todos () |
virtual Todo * | todo (const QString &uid)=0 |
virtual Todo::List | todos (const QDate &date)=0 |
virtual Todo::List | rawTodos ()=0 |
virtual bool | addJournal (Journal *)=0 |
virtual void | deleteJournal (Journal *)=0 |
virtual Journal * | journal (const QDate &)=0 |
virtual Journal * | journal (const QString &UID)=0 |
virtual Journal::List | journals ()=0 |
Incidence * | incidence (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 | setModified (bool) |
void | setLoadedProductId (const QString &) |
QString | loadedProductId () |
virtual bool | beginChange (Incidence *) |
virtual bool | endChange (Incidence *) |
Static Public Methods | |
Incidence::List | mergeIncidenceList (const Event::List &, const Todo::List &, const Journal::List &) |
Protected Methods | |
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 |
virtual void | doSetTimeZoneId (const QString &) |
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.
Definition at line 60 of file calendar.h.
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.
Definition at line 114 of file calendar.cpp. |
|
Set the owner of the calendar. Should be owner's full name. Definition at line 119 of file calendar.cpp. References QString::find(), and QString::left(). |
|
Return the email address of the calendar owner.
Definition at line 158 of file calendar.cpp. Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Set the email address of the calendar owner.
Definition at line 163 of file calendar.cpp. |
|
Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal values).
Definition at line 130 of file calendar.cpp. References doSetTimeZoneId(). Referenced by KCal::ResourceKABC::setTimeZoneId(), KCal::ResourceIMAP::setTimeZoneId(), and KCal::ResourceCached::setTimeZoneId(). |
|
Return time zone id.
Definition at line 139 of file calendar.cpp. Referenced by KCal::DndFactory::copyEvent(), KCal::DndFactory::copyTodo(), KCal::DndFactory::createDrag(), KCal::DndFactory::createDrop(), KCal::DndFactory::createDropTodo(), KCal::ICalFormat::fromString(), KCal::VCalFormat::ISOToQDateTime(), KCal::ICalFormat::parseScheduleMessage(), KCal::DndFactory::pasteIncidence(), KCal::VCalFormat::qDateTimeToISO(), KCal::Scheduler::Scheduler(), and KCal::ICalFormat::toString(). |
|
Use local time, not UTC or a time zone.
Definition at line 144 of file calendar.cpp. |
|
Return whether local time is being used.
Definition at line 153 of file calendar.cpp. Referenced by KCal::ICalFormat::fromString(), KCal::ICalFormat::parseScheduleMessage(), KCal::Scheduler::Scheduler(), and KCal::ICalFormat::toString(). |
|
Add an incidence to calendar.
Reimplemented in KCal::CalendarResources. Definition at line 222 of file calendar.cpp. References KCal::Incidence::accept(). Referenced by KCal::DndFactory::createDrag(), and KCal::ICalFormat::toICalString(). |
|
Delete an incidence from calendar.
Definition at line 229 of file calendar.cpp. References KCal::Incidence::accept(). |
|
Return filtered list of all incidences of this calendar.
Definition at line 180 of file calendar.cpp. References events(), journals(), mergeIncidenceList(), and todos(). Referenced by mergeIncidenceList(). |
|
Return unfiltered list of all incidences of this calendar.
Definition at line 185 of file calendar.cpp. References journals(), mergeIncidenceList(), rawEvents(), and rawTodos(). |
|
Adds a Event to this calendar object.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by KCal::VCalFormat::fromString(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::populate(). |
|
Delete event from calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by KCal::DndFactory::cutEvent(). |
|
Retrieves an event on the basis of the unique string ID.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by incidence(), KCal::ICalFormat::parseScheduleMessage(), and KCal::VCalFormat::populate(). |
|
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. Definition at line 190 of file calendar.cpp. References KCal::CalFilter::apply(), and rawEventsForDate(). Referenced by KCal::DndFactory::createDrop(), KCal::ICalFormat::fromString(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::toString(). |
|
Get events, which occur on the given date. The calendar filter is applied. Definition at line 199 of file calendar.cpp. References KCal::CalFilter::apply(), and rawEventsForDate(). |
|
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. Definition at line 206 of file calendar.cpp. References KCal::CalFilter::apply(), and rawEvents(). |
|
Return filtered list of all events in calendar.
Definition at line 214 of file calendar.cpp. References KCal::CalFilter::apply(), and rawEvents(). Referenced by incidences(). |
|
Return unfiltered list of all events in calendar.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by events(), rawIncidences(), KCal::VCalFormat::save(), and KCal::ICalFormat::toString(). |
|
Add a todo to the todolist.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::populate(). |
|
Remove a todo from the todolist.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by KCal::DndFactory::cutTodo(). |
|
Return filterd list of todos.
Reimplemented in KCal::CalendarLocal, and KCal::CalendarResources. Definition at line 245 of file calendar.cpp. References KCal::CalFilter::apply(), and rawTodos(). Referenced by incidences(). |
|
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by incidence(), and KCal::VCalFormat::populate(). |
|
Returns list of todos due on the specified date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return unfiltered list of todos.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by rawIncidences(), KCal::VCalFormat::save(), todos(), and KCal::ICalFormat::toString(). |
|
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 for given date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by incidence(). |
|
Return Journal with given UID.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Return list of all Journal entries.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by incidences(), rawIncidences(), and KCal::ICalFormat::toString(). |
|
Searches all incidence types for an incidence with this unique string identifier, returns a pointer or null.
Definition at line 235 of file calendar.cpp. References event(), journal(), and todo(). Referenced by setupRelations(). |
|
Setup relations for an incidence.
Definition at line 254 of file calendar.cpp. References KCal::Incidence::addRelation(), incidence(), QDict< Incidence >::insert(), QString::isEmpty(), QObject::parent(), KCal::Incidence::relatedTo(), KCal::Incidence::relatedToUid(), QDict< Incidence >::remove(), KCal::Incidence::setRelatedTo(), and KCal::IncidenceBase::uid(). Referenced by KCal::CalendarLocal::addTodo(). |
|
Remove all relations to an incidence.
Definition at line 284 of file calendar.cpp. References QDictIterator::current(), QDictIterator::currentKey(), QDict< Incidence >::find(), QDict< Incidence >::insert(), KCal::Incidence::relatedTo(), KCal::Incidence::relations(), QDict< Incidence >::remove(), KCal::Incidence::removeRelation(), KCal::Incidence::setRelatedTo(), KCal::Incidence::setRelatedToUid(), and KCal::IncidenceBase::uid(). Referenced by KCal::CalendarLocal::deleteTodo(). |
|
Set calendar filter, which filters events for the events() functions. The Filter object is owned by the caller. Definition at line 170 of file calendar.cpp. |
|
Return calendar filter.
Definition at line 175 of file calendar.cpp. |
|
Return all alarms, which ocur in the given time interval.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. |
|
Set product id returned by loadedProductId(). This function is only useful for the calendar loading code. Definition at line 338 of file calendar.cpp. |
|
Return product id taken from file that has been loaded. Returns QString::null, if no calendar has been loaded. Definition at line 343 of file calendar.cpp. |
|
Merge lists of events, todos and journals to a list of incidences.
Definition at line 348 of file calendar.cpp. References incidences(). Referenced by incidences(), and rawIncidences(). |
|
Get unfiltered events, which occur on the given date.
Implemented in KCal::CalendarLocal, KCal::CalendarNull, and KCal::CalendarResources. Referenced by events(). |
|
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. Definition at line 316 of file calendar.h. Referenced by setTimeZoneId(). |
The documentation for this class was generated from the following files: