journal.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.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 KCALCORE_JOURNAL_H
#define KCALCORE_JOURNAL_H

#include "kcalcore_export.h"
#include "incidence.h"
#include "supertrait.h"

namespace KCalCore {

class KCALCORE_EXPORT Journal : public Incidence
{
public:
    typedef QSharedPointer<Journal> Ptr;

    typedef QVector<Ptr> List;

    Journal();

    ~Journal();

    IncidenceType type() const;

    QByteArray typeStr() const;

    Journal *clone() const;

    KDateTime dateTime(DateTimeRole role) const;

    void setDateTime(const KDateTime &dateTime, DateTimeRole role);

    QLatin1String mimeType() const;

    QLatin1String iconName(const KDateTime &recurrenceId = KDateTime()) const;

    static QLatin1String journalMimeType();

protected:
    bool equals(const IncidenceBase &journal) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

    virtual void virtual_hook(int id, void *data);

private:
    bool accept(Visitor &v, IncidenceBase::Ptr incidence);

    Journal &operator=(const Journal &other);

    // For polymorfic serialization
    void serialize(QDataStream &out);
    void deserialize(QDataStream &in);

    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};


} // namespace KCalCore

//@cond PRIVATE
Q_DECLARE_TYPEINFO(KCalCore::Journal::Ptr, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KCalCore::Journal::Ptr)
//@endcond

//@cond PRIVATE
namespace KPIMUtils {
// super class trait specialization
template <> struct SuperClass<KCalCore::Journal> : public SuperClassTrait<KCalCore::Incidence> {};
}
//@endcond

#endif