notebook.h

Go to the documentation of this file.

/*
  This file is part of the mkcal library.
 
  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_NOTEBOOK_H
#define MKCAL_NOTEBOOK_H
 
#include "mkcal_export.h"
 
#include <incidence.h>
 
#include <kdatetime.h>
 
#include <QtCore/QList>
 
namespace mKCal {
 
class MKCAL_EXPORT Notebook
{
public:
    typedef QSharedPointer<Notebook> Ptr;
 
    typedef QSharedPointer<const Notebook> ConstPtr;
 
    typedef QList<Ptr> List;
 
    explicit Notebook();
 
    explicit Notebook(const QString &name, const QString &description);
 
    explicit Notebook(const QString &uid, const QString &name,
                      const QString &description, const QString &color,
                      bool isShared, bool isMaster, bool oviSync,
                      bool isReadOnly, bool isVisible);
 
    explicit Notebook(const QString &uid, const QString &name,
                      const QString &description, const QString &color,
                      bool isShared, bool isMaster, bool isSynchronized,
                      bool isReadOnly, bool isVisible, const QString &pluginName,
                      const QString &account, int attachmentSize);
 
    explicit Notebook(const Notebook &n);
 
    virtual ~Notebook();
 
    QString uid() const;
 
    void setUid(const QString &uid);
 
    QString name() const;
 
    void setName(const QString &name);
 
    QString description() const;
 
    void setDescription(const QString &description);
 
    QString color() const;
 
    void setColor(const QString &color);
 
    bool isShared() const;
 
    void setIsShared(bool isShared);
 
    bool isMaster() const;
 
    void setIsMaster(bool isMaster);
 
    bool isSynchronized() const;
 
    void setIsSynchronized(bool oviSync);
 
    bool isReadOnly() const;
 
    void setIsReadOnly(bool isReadOnly);
 
    bool isVisible() const;
 
    void setIsVisible(bool isVisible);
 
    bool isRunTimeOnly() const;
 
    void setRunTimeOnly(bool isRunTime);
 
    KDateTime syncDate() const;
 
    void setSyncDate(const KDateTime &syncDate);
 
    QString pluginName() const;
 
    void setPluginName(const QString &pluginName);
 
    QString account() const;
 
    void setAccount(const QString &account);
 
    int attachmentSize() const;
 
    void setAttachmentSize(int size);
 
    KDateTime modifiedDate() const;
 
    void setModifiedDate(const KDateTime &modifiedDate);
 
    KDateTime creationDate() const;
 
    void setCreationDate(const KDateTime &date);
 
    bool isDefault() const;
 
    void setIsDefault(bool isDefault);
 
    bool isShareable() const;
 
    void setIsShareable(bool isShareable);
 
    QStringList sharedWith() const;
 
    QString sharedWithStr() const;
 
    void setSharedWith(const QStringList &sharedWith);
 
    void setSharedWithStr(const QString &sharedWith);
 
    QString syncProfile() const;
 
    void setSyncProfile(const QString &syncProfile);
 
    void setEventsAllowed(bool eventsAllowed);
 
    bool eventsAllowed() const;
 
    void setJournalsAllowed(bool journalsAllowed);
 
    bool journalsAllowed() const;
 
    void setTodosAllowed(bool todosAllowed);
 
    bool todosAllowed() const;
 
    bool incidenceAllowed(KCalCore::Incidence::Ptr incidence) const;
 
    void setFlags(int flags);
 
    int flags() const;
 
    void setCustomProperty(const QByteArray &key, const QString &value);
 
    QString customProperty(const QByteArray &key, const QString &defaultValue = QString()) const;
 
    QList<QByteArray> customPropertyKeys() const;
 
    Notebook &operator=(const Notebook &other);
 
    bool operator==(const Notebook &notebook) const;
 
private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};
 
}
 
#endif