calendarbase.h

/*
   Copyright (C) 2011 Sérgio Martins <sergio.martins@kdab.com>
   Copyright (C) 2012 Sérgio Martins <iamsergio@gmail.com>

   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 _AKONADI_CALENDARBASE_H_
#define _AKONADI_CALENDARBASE_H_

#include "akonadi-calendar_export.h"

#include <akonadi/item.h>
#include <akonadi/collection.h>
#include <kcalcore/memorycalendar.h>
#include <kcalcore/incidence.h>
#include <KDE/KDateTime>

namespace Akonadi {

class CalendarBasePrivate;
class IncidenceChanger;

class AKONADI_CALENDAR_EXPORT CalendarBase : public KCalCore::MemoryCalendar
{
    Q_OBJECT
public:
    typedef QSharedPointer<CalendarBase> Ptr;

    explicit CalendarBase(QObject *parent = 0);

    ~CalendarBase();

    Akonadi::Item item(const QString &uid) const;

    Akonadi::Item item(const KCalCore::Incidence::Ptr &incidence) const;

    Akonadi::Item item(Akonadi::Item::Id) const;

    Akonadi::Item::List items() const;

    Akonadi::Item::List items(Akonadi::Collection::Id) const;

    Akonadi::Item::List itemList(const KCalCore::Incidence::List &incidenceList) const;
 //TODO: unit-test
    KCalCore::Incidence::List childIncidences(const QString &parentUid) const;

    KCalCore::Incidence::List childIncidences(const Akonadi::Item::Id &parentId) const;

    Akonadi::Item::List childItems(const QString &parentUid) const;

    Akonadi::Item::List childItems(const Akonadi::Item::Id &parentId) const;

    void setWeakPointer(const QWeakPointer<Akonadi::CalendarBase> &pointer);

    QWeakPointer<CalendarBase> weakPointer() const;
 bool addEvent(const KCalCore::Event::Ptr &event);
 bool deleteEvent(const KCalCore::Event::Ptr &event);
 void deleteAllEvents();
 bool addTodo(const KCalCore::Todo::Ptr &todo);
 bool deleteTodo(const KCalCore::Todo::Ptr &todo);
 void deleteAllTodos();
 bool addJournal(const KCalCore::Journal::Ptr &journal);
 bool deleteJournal(const KCalCore::Journal::Ptr &journal);
 void deleteAllJournals();
 bool addIncidence(const KCalCore::Incidence::Ptr &incidence);
 bool deleteIncidence(const KCalCore::Incidence::Ptr &);
 void startBatchAdding();
 void endBatchAdding();

    Akonadi::IncidenceChanger *incidenceChanger() const;

    bool modifyIncidence(const KCalCore::Incidence::Ptr &newIncidence);

Q_SIGNALS:
    void createFinished(bool success, const QString &errorMessage);

    void deleteFinished(bool success, const QString &errorMessage);

    void modifyFinished(bool success, const QString &errorMessage);

protected:
    Q_DECLARE_PRIVATE(CalendarBase)
    QScopedPointer<CalendarBasePrivate> d_ptr;
    CalendarBase(CalendarBasePrivate *const d, QObject *parent);

    friend class Scheduler;
};
}

#endif