• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • MemoryCalendar
Public Types | Public Member Functions | Protected Member Functions
KCalCore::MemoryCalendar Class Reference

#include <memorycalendar.h>

Inheritance diagram for KCalCore::MemoryCalendar:
Inheritance graph
[legend]

List of all members.

Public Types

typedef QSharedPointer
< MemoryCalendar > 
Ptr

Public Member Functions

 MemoryCalendar (const KDateTime::Spec &timeSpec)
 MemoryCalendar (const QString &timeZoneId)
 ~MemoryCalendar ()
bool addEvent (const Event::Ptr &event)
bool addIncidence (const Incidence::Ptr &incidence)
bool addJournal (const Journal::Ptr &journal)
bool addTodo (const Todo::Ptr &todo)
Alarm::List alarms (const KDateTime &from, const KDateTime &to) const
Alarm::List alarmsTo (const KDateTime &to) const
void close ()
void deleteAllEvents ()
void deleteAllJournals ()
void deleteAllTodos ()
Event::Ptr deletedEvent (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Event::List deletedEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Journal::Ptr deletedJournal (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Journal::List deletedJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Todo::Ptr deletedTodo (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Todo::List deletedTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
bool deleteEvent (const Event::Ptr &event)
bool deleteEventInstances (const Event::Ptr &event)
bool deleteIncidence (const Incidence::Ptr &incidence)
bool deleteIncidenceInstances (const Incidence::Ptr &incidence)
bool deleteJournal (const Journal::Ptr &journal)
bool deleteJournalInstances (const Journal::Ptr &journal)
bool deleteTodo (const Todo::Ptr &todo)
bool deleteTodoInstances (const Todo::Ptr &todo)
Event::Ptr event (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Event::List eventInstances (const Incidence::Ptr &event, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
void incidenceUpdate (const QString &uid, const KDateTime &recurrenceId)
void incidenceUpdated (const QString &uid, const KDateTime &recurrenceId)
Journal::Ptr journal (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Journal::List journalInstances (const Incidence::Ptr &journal, JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Event::List rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Event::List rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false) const
Event::List rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Event::List rawEventsForDate (const KDateTime &dt) const
Journal::List rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Journal::List rawJournalsForDate (const QDate &date) const
Todo::List rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Todo::List rawTodos (const QDate &start, const QDate &end, const KDateTime::Spec &timespec=KDateTime::Spec(), bool inclusive=false) const
Todo::List rawTodosForDate (const QDate &date) const
Todo::Ptr todo (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
Todo::List todoInstances (const Incidence::Ptr &todo, TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const

Protected Member Functions

virtual void virtual_hook (int id, void *data)

Detailed Description

This class provides a calendar stored in memory.

Definition at line 46 of file memorycalendar.h.


Member Typedef Documentation

typedef QSharedPointer<MemoryCalendar> KCalCore::MemoryCalendar::Ptr

A shared pointer to a MemoryCalendar.

Reimplemented from KCalCore::Calendar.

Definition at line 53 of file memorycalendar.h.


Constructor & Destructor Documentation

KCalCore::MemoryCalendar::MemoryCalendar ( const KDateTime::Spec &  timeSpec) [explicit]

Constructs a calendar with a specified time zone timeZoneid.

Private class that helps to provide binary compatibility between releases.

The time specification is used as the default for creating or modifying incidences in the Calendar. The time specification does not alter existing incidences.

The constructor also calls setViewTimeSpec(timeSpec).

Parameters:
timeSpectime specification
KCalCore::MemoryCalendar::MemoryCalendar ( const QString &  timeZoneId) [explicit]

Construct Calendar object using a time zone ID.

The time zone ID is used as the default for creating or modifying incidences in the Calendar. The time zone does not alter existing incidences.

The constructor also calls setViewTimeZoneId(timeZoneId).

Parameters:
timeZoneIdis a string containing a time zone ID, which is assumed to be valid. If no time zone is found, the viewing time specification is set to local clock time. Example: "Europe/Berlin"
KCalCore::MemoryCalendar::~MemoryCalendar ( )

Destroys the calendar.


Member Function Documentation

bool KCalCore::MemoryCalendar::addEvent ( const Event::Ptr &  event) [virtual]

Inserts an Event into the calendar.

Parameters:
eventis a pointer to the Event to insert.
Returns:
true if the Event was successfully inserted; false otherwise.
See also:
deleteEvent()

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::addIncidence ( const Incidence::Ptr &  incidence) [virtual]

Inserts an Incidence into the calendar.

Parameters:
incidenceis a pointer to the Incidence to insert.
Returns:
true if the Incidence was successfully inserted; false otherwise.
See also:
deleteIncidence()

Reimplemented from KCalCore::Calendar.

bool KCalCore::MemoryCalendar::addJournal ( const Journal::Ptr &  journal) [virtual]

Inserts a Journal into the calendar.

Parameters:
journalis a pointer to the Journal to insert.
Returns:
true if the Journal was successfully inserted; false otherwise.
See also:
deleteJournal()

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::addTodo ( const Todo::Ptr &  todo) [virtual]

Inserts a Todo into the calendar.

Parameters:
todois a pointer to the Todo to insert.
Returns:
true if the Todo was successfully inserted; false otherwise.
See also:
deleteTodo()

Implements KCalCore::Calendar.

Alarm::List KCalCore::MemoryCalendar::alarms ( const KDateTime &  from,
const KDateTime &  to 
) const [virtual]

Returns a list of Alarms within a time range for this Calendar.

Parameters:
fromis the starting timestamp.
tois the ending timestamp.
Returns:
the list of Alarms for the for the specified time range.

Implements KCalCore::Calendar.

Alarm::List KCalCore::MemoryCalendar::alarmsTo ( const KDateTime &  to) const

Return a list of Alarms that occur before the specified timestamp.

Parameters:
tois the ending timestamp.
Returns:
the list of Alarms occurring before the specified KDateTime.
void KCalCore::MemoryCalendar::close ( ) [virtual]

Clears out the current calendar, freeing all used memory etc.

etc.

Implements KCalCore::Calendar.

void KCalCore::MemoryCalendar::deleteAllEvents ( ) [virtual]

Removes all Events from the calendar.

See also:
deleteEvent()

Implements KCalCore::Calendar.

void KCalCore::MemoryCalendar::deleteAllJournals ( ) [virtual]

Removes all Journals from the calendar.

See also:
deleteJournal()

Implements KCalCore::Calendar.

void KCalCore::MemoryCalendar::deleteAllTodos ( ) [virtual]

Removes all To-dos from the calendar.

See also:
deleteTodo()

Implements KCalCore::Calendar.

Event::Ptr KCalCore::MemoryCalendar::deletedEvent ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the deleted Event associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of event, default is null
Returns:
a pointer to the deleted Event. A null pointer is returned if no such deleted Event exists.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::deletedEvents ( EventSortField  sortField = EventSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all deleted Events for this Calendar.

Parameters:
sortFieldspecifies the EventSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered deleted Events sorted as specified.

Implements KCalCore::Calendar.

Journal::Ptr KCalCore::MemoryCalendar::deletedJournal ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the deleted Journal associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of journal, default is null
Returns:
a pointer to the deleted Journal. A null pointer is returned if no such deleted Journal exists.

Implements KCalCore::Calendar.

Journal::List KCalCore::MemoryCalendar::deletedJournals ( JournalSortField  sortField = JournalSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all deleted Journals for this Calendar.

Parameters:
sortFieldspecifies the JournalSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered deleted Journals sorted as specified.

Implements KCalCore::Calendar.

Todo::Ptr KCalCore::MemoryCalendar::deletedTodo ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the deleted Todo associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of todo, default is null
Returns:
a pointer to the deleted Todo. A null pointer is returned if no such deletef Todo exists.

Implements KCalCore::Calendar.

Todo::List KCalCore::MemoryCalendar::deletedTodos ( TodoSortField  sortField = TodoSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all deleted Todos for this Calendar.

Parameters:
sortFieldspecifies the TodoSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered deleted Todos sorted as specified.

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteEvent ( const Event::Ptr &  event) [virtual]

Removes an Event from the calendar.

Parameters:
eventis a pointer to the Event to remove.
Returns:
true if the Event was successfully remove; false otherwise.
See also:
addEvent(), deleteAllEvents()

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteEventInstances ( const Event::Ptr &  event) [virtual]

Delete all events that are instances of recurring event event.

Parameters:
eventis a pointer to a deleted Event
Returns:
true if delete was successful; false otherwise

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteIncidence ( const Incidence::Ptr &  incidence) [virtual]

Removes an Incidence from the calendar.

Parameters:
incidenceis a pointer to the Incidence to remove.
Returns:
true if the Incidence was successfully removed; false otherwise.
See also:
addIncidence()

Reimplemented from KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteIncidenceInstances ( const Incidence::Ptr &  incidence) [virtual]

Delete all incidences that are instances of recurring incidence incidence.

Parameters:
incidenceis a pointer to a deleted Incidence
Returns:
true if delete was successful; false otherwise

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteJournal ( const Journal::Ptr &  journal) [virtual]

Removes a Journal from the calendar.

Parameters:
journalis a pointer to the Journal to remove.
Returns:
true if the Journal was successfully removed; false otherwise.
See also:
addJournal(), deleteAllJournals()

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteJournalInstances ( const Journal::Ptr &  journal) [virtual]

Delete all journals that are instances of recurring journal journal.

Parameters:
journalis a pointer to a deleted Journal
Returns:
true if delete was successful; false otherwise

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteTodo ( const Todo::Ptr &  todo) [virtual]

Removes a Todo from the calendar.

Parameters:
todois a pointer to the Todo to remove.
Returns:
true if the Todo was successfully removed; false otherwise.
See also:
addTodo(), deleteAllTodos()

Implements KCalCore::Calendar.

bool KCalCore::MemoryCalendar::deleteTodoInstances ( const Todo::Ptr &  todo) [virtual]

Delete all to-dos that are instances of recurring to-do todo.

Parameters:
todois a pointer to a deleted Todo
Returns:
true if delete was successful; false otherwise

Implements KCalCore::Calendar.

Event::Ptr KCalCore::MemoryCalendar::event ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the Event associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of event, default is null
Returns:
a pointer to the Event. A null pointer is returned if no such Event exists.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::eventInstances ( const Incidence::Ptr &  event,
EventSortField  sortField = EventSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all possible instances for this recurring Event.

Parameters:
eventevent to check for. Caller guarantees it's of type Event.
sortFieldspecifies the EventSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered event instances sorted as specified.

Implements KCalCore::Calendar.

void KCalCore::MemoryCalendar::incidenceUpdate ( const QString &  uid,
const KDateTime &  recurrenceId 
) [virtual]

The IncidenceObserver interface.

This function is called before any changes are made.

Parameters:
uidis the string containing the incidence uid.
recurrenceIdis possible recurrenceid of incidence.

Implements KCalCore::IncidenceBase::IncidenceObserver.

void KCalCore::MemoryCalendar::incidenceUpdated ( const QString &  uid,
const KDateTime &  recurrenceId 
) [virtual]

The Observer interface.

So far not implemented.

Parameters:
uidis the UID for the Incidence that has been updated.
recurrenceIdis possible recurrenceid of incidence.

Reimplemented from KCalCore::Calendar.

Journal::Ptr KCalCore::MemoryCalendar::journal ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the Journal associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of journal, default is null
Returns:
a pointer to the Journal. A null pointer is returned if no such Journal exists.

Implements KCalCore::Calendar.

Journal::List KCalCore::MemoryCalendar::journalInstances ( const Incidence::Ptr &  journal,
JournalSortField  sortField = JournalSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all instances for this recurring Journal.

Parameters:
journaljournal to check for. Caller guarantees it's of type Journal.
sortFieldspecifies the JournalSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered journal instances sorted as specified.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::rawEvents ( EventSortField  sortField = EventSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all Events for this Calendar.

Parameters:
sortFieldspecifies the EventSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered Events sorted as specified.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::rawEvents ( const QDate &  start,
const QDate &  end,
const KDateTime::Spec &  timeSpec = KDateTime::Spec(),
bool  inclusive = false 
) const [virtual]

Returns an unfiltered list of all Events occurring within a date range.

Parameters:
startis the starting date
endis the ending date
timeSpectime zone etc. to interpret start and end, or the calendar's default time spec if none is specified
inclusiveif true only Events which are completely included within the date range are returned.
Returns:
the list of unfiltered Events occurring within the specified date range.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::rawEventsForDate ( const QDate &  date,
const KDateTime::Spec &  timeSpec = KDateTime::Spec(),
EventSortField  sortField = EventSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns an unfiltered list of all Events which occur on the given date.

Parameters:
daterequest unfiltered Event list for this QDate only.
timeSpectime zone etc. to interpret date, or the calendar's default time spec if none is specified
sortFieldspecifies the EventSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of unfiltered Events occurring on the specified QDate.

Implements KCalCore::Calendar.

Event::List KCalCore::MemoryCalendar::rawEventsForDate ( const KDateTime &  dt) const [virtual]

Returns an unfiltered list of all Events which occur on the given timestamp.

Parameters:
dtrequest unfiltered Event list for this KDateTime only.
Returns:
the list of unfiltered Events occurring on the specified timestamp.

Implements KCalCore::Calendar.

Journal::List KCalCore::MemoryCalendar::rawJournals ( JournalSortField  sortField = JournalSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all Journals for this Calendar.

Parameters:
sortFieldspecifies the JournalSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered Journals sorted as specified.

Implements KCalCore::Calendar.

Journal::List KCalCore::MemoryCalendar::rawJournalsForDate ( const QDate &  date) const [virtual]

Returns an unfiltered list of all Journals for on the specified date.

Parameters:
daterequest unfiltered Journals for this QDate only.
Returns:
the list of unfiltered Journals for the specified date.

Implements KCalCore::Calendar.

Todo::List KCalCore::MemoryCalendar::rawTodos ( TodoSortField  sortField = TodoSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all Todos for this Calendar.

Parameters:
sortFieldspecifies the TodoSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered Todos sorted as specified.

Implements KCalCore::Calendar.

Todo::List KCalCore::MemoryCalendar::rawTodos ( const QDate &  start,
const QDate &  end,
const KDateTime::Spec &  timespec = KDateTime::Spec(),
bool  inclusive = false 
) const [virtual]

Returns an unfiltered list of all Todos occurring within a date range.

Parameters:
startis the starting date
endis the ending date
timespectime zone etc. to interpret start and end, or the calendar's default time spec if none is specified
inclusiveif true only Todos which are completely included within the date range are returned.
Returns:
the list of unfiltered Todos occurring within the specified date range.

Implements KCalCore::Calendar.

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

Returns an unfiltered list of all Todos which due on the specified date.

Parameters:
daterequest unfiltered Todos due on this QDate.
Returns:
the list of unfiltered Todos due on the specified date.

Implements KCalCore::Calendar.

Todo::Ptr KCalCore::MemoryCalendar::todo ( const QString &  uid,
const KDateTime &  recurrenceId = KDateTime() 
) const [virtual]

Returns the Todo associated with the given unique identifier.

Parameters:
uidis a unique identifier string.
recurrenceIdis possible recurrenceId of todo, default is null
Returns:
a pointer to the Todo. A null pointer is returned if no such Todo exists.

Implements KCalCore::Calendar.

Todo::List KCalCore::MemoryCalendar::todoInstances ( const Incidence::Ptr &  todo,
TodoSortField  sortField = TodoSortUnsorted,
SortDirection  sortDirection = SortDirectionAscending 
) const [virtual]

Returns a sorted, unfiltered list of all possible instances for this recurring Todo.

Parameters:
todotodo to check for. Caller guarantees it's of type Todo.
sortFieldspecifies the TodoSortField.
sortDirectionspecifies the SortDirection.
Returns:
the list of all unfiltered todo instances sorted as specified.

Implements KCalCore::Calendar.

virtual void KCalCore::MemoryCalendar::virtual_hook ( int  id,
void *  data 
) [protected, virtual]

Standard trick to add virtuals later.

Parameters:
idis any integer unique to this class which we will use to identify the method to be called.
datais a pointer to some glob of data, typically a struct.

Reimplemented from KCalCore::Calendar.


The documentation for this class was generated from the following file:
  • memorycalendar.h

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal