extendedcalendar.h

Go to the documentation of this file.

/*
  This file is part of the mkcal library.
 
  Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
  Contact: Alvaro Manera <alvaro.manera@nokia.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 MKCAL_EXTENDEDCALENDAR_H
#define MKCAL_EXTENDEDCALENDAR_H
 
#include "mkcal_export.h"
 
#include <KCalendarCore/MemoryCalendar>
 
namespace mKCal {
 
class ExtendedStorage;
class Notebook;

class MKCAL_EXPORT ExtendedCalendar : public KCalendarCore::MemoryCalendar
{
public:
    typedef QSharedPointer<ExtendedCalendar> Ptr;

    explicit ExtendedCalendar(const QTimeZone &timeZone);

    explicit ExtendedCalendar(const QByteArray &timeZoneId);

    ~ExtendedCalendar();

    bool reload();

    bool save();

    void close();

    KCalendarCore::Incidence::Ptr dissociateSingleOccurrence(const KCalendarCore::Incidence::Ptr &incidence,
                                                             const QDateTime &dateTime);

    bool addIncidence(const KCalendarCore::Incidence::Ptr &incidence);

    bool addIncidence(const KCalendarCore::Incidence::Ptr &incidence, const QString &notebookUid);
 
    // Event Specific Methods //

    bool addEvent(const KCalendarCore::Event::Ptr &event);

    bool addEvent(const KCalendarCore::Event::Ptr &event, const QString &notebookUid);
 
    // To-do Specific Methods //

    bool addTodo(const KCalendarCore::Todo::Ptr &todo);

    bool addTodo(const KCalendarCore::Todo::Ptr &todo, const QString &notebookUid);
 
    // Journal Specific Methods //

    bool addJournal(const KCalendarCore::Journal::Ptr &journal);

    bool addJournal(const KCalendarCore::Journal::Ptr &journal, const QString &notebookUid);
 
    using KCalendarCore::Calendar::journals;

    KCalendarCore::Journal::List journals(const QDate &start, const QDate &end);
 
    using KCalendarCore::Calendar::incidences;

    KCalendarCore::Incidence::List incidences(const QDate &start, const QDate &end);

    static QSharedPointer<ExtendedStorage> defaultStorage(const ExtendedCalendar::Ptr
                                                          &calendar);   //No typedef to avoid cyclic includes
 
    // Adopt the deprecated notebook API from KF6.    
    void clearNotebookAssociations();

    bool setNotebook(const KCalendarCore::Incidence::Ptr &incidence, const QString &notebook);

    QString notebook(const KCalendarCore::Incidence::Ptr &incidence) const;

    QString notebook(const QString &uid) const;

    QStringList notebooks() const;

    Q_REQUIRED_RESULT bool hasValidNotebook(const QString &notebook) const;

    Q_REQUIRED_RESULT bool addNotebook(const QString &notebook, bool isVisible);

    Q_REQUIRED_RESULT bool updateNotebook(const QString &notebook, bool isVisible);

    Q_REQUIRED_RESULT bool deleteNotebook(const QString &notebook);

    Q_REQUIRED_RESULT bool setDefaultNotebook(const QString &notebook);

    Q_REQUIRED_RESULT QString defaultNotebook() const;

    Q_REQUIRED_RESULT bool isVisible(const KCalendarCore::Incidence::Ptr &incidence) const;

    Q_REQUIRED_RESULT bool isVisible(const QString &notebook) const;

    KCalendarCore::Incidence::List incidences(const QString &notebook) const;

    KCalendarCore::Incidence::List duplicates(const KCalendarCore::Incidence::Ptr &incidence);
 
private:
    //@cond PRIVATE
    Q_DISABLE_COPY(ExtendedCalendar)
    class Private;
    Private *const d;
    //@endcond
};
 
}
 
#endif