memorycalendar.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.
 
  Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.
 
  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/
#ifndef KCALCORE_MEMORYCALENDAR_H
#define KCALCORE_MEMORYCALENDAR_H
 
#include "kcalcore_export.h"
#include "calendar.h"
 
namespace KCalCore {
 
class CalFormat;
 
class KCALCORE_EXPORT MemoryCalendar : public Calendar
{
public:
 
    typedef QSharedPointer<MemoryCalendar> Ptr;
 
    explicit MemoryCalendar(const KDateTime::Spec &timeSpec);
 
    explicit MemoryCalendar(const QString &timeZoneId);
 
    ~MemoryCalendar();
 
    void close();
 
    bool deleteIncidence(const Incidence::Ptr &incidence);
 
    bool deleteIncidenceInstances(const Incidence::Ptr &incidence);
 
    bool addIncidence(const Incidence::Ptr &incidence);
 
    // Event Specific Methods //
 
    bool addEvent(const Event::Ptr &event);
 
    bool deleteEvent(const Event::Ptr &event);
 
    bool deleteEventInstances(const Event::Ptr &event);
 
    void deleteAllEvents();
 
    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;
 
    Incidence::Ptr instance(const QString &identifier) const;
 
    Event::Ptr event(
        const QString &uid,
        const KDateTime &recurrenceId = KDateTime()) const;
 
    Event::Ptr deletedEvent(
        const QString &uid, const KDateTime &recurrenceId = KDateTime()) const;
 
    Event::List deletedEvents(
        EventSortField sortField = EventSortUnsorted,
        SortDirection sortDirection = SortDirectionAscending) const;
 
    Event::List eventInstances(
        const Incidence::Ptr &event,
        EventSortField sortField = EventSortUnsorted,
        SortDirection sortDirection = SortDirectionAscending) const;
 
    // To-do Specific Methods //
 
    bool addTodo(const Todo::Ptr &todo);
 
    bool deleteTodo(const Todo::Ptr &todo);
 
    bool deleteTodoInstances(const Todo::Ptr &todo);
 
    void deleteAllTodos();
 
    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::Ptr deletedTodo(const QString &uid, const KDateTime &recurrenceId = KDateTime()) const;
 
    Todo::List deletedTodos(
        TodoSortField sortField = TodoSortUnsorted,
        SortDirection sortDirection = SortDirectionAscending) const;
 
    Todo::List todoInstances(const Incidence::Ptr &todo,
                             TodoSortField sortField = TodoSortUnsorted,
                             SortDirection sortDirection = SortDirectionAscending) const;
 
    // Journal Specific Methods //
 
    bool addJournal(const Journal::Ptr &journal);
 
    bool deleteJournal(const Journal::Ptr &journal);
 
    bool deleteJournalInstances(const Journal::Ptr &journal);
 
    void deleteAllJournals();
 
    Journal::List rawJournals(
        JournalSortField sortField = JournalSortUnsorted,
        SortDirection sortDirection = SortDirectionAscending) const;
 
    Journal::List rawJournalsForDate(const QDate &date) const;
 
    Journal::Ptr journal(const QString &uid,
                         const KDateTime &recurrenceId = KDateTime()) const;
 
    Journal::Ptr deletedJournal(const QString &uid,
                                const KDateTime &recurrenceId = KDateTime()) const;
 
    Journal::List deletedJournals(
        JournalSortField sortField = JournalSortUnsorted,
        SortDirection sortDirection = SortDirectionAscending) const;
 
    Journal::List journalInstances(const Incidence::Ptr &journal,
                                   JournalSortField sortField = JournalSortUnsorted,
                                   SortDirection sortDirection = SortDirectionAscending) const;
 
    // Alarm Specific Methods //
 
    Alarm::List alarms(const KDateTime &from, const KDateTime &to) const;
 
    Alarm::List alarmsTo(const KDateTime &to) const;
 
    void incidenceUpdate(const QString &uid, const KDateTime &recurrenceId);
 
    void incidenceUpdated(const QString &uid, const KDateTime &recurrenceId);
 
    using QObject::event;   // prevent warning about hidden virtual method
 
protected:
    virtual void virtual_hook(int id, void *data);
 
private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
 
    Q_DISABLE_COPY(MemoryCalendar)
};
 
}
 
#endif