todo.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) 2009 Allen Winter <winter@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_TODO_H
#define KCALCORE_TODO_H

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

namespace KCalCore {

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

    typedef QVector<Ptr> List;

    Todo();

    Todo(const Todo &other);

    ~Todo();

    IncidenceType type() const;

    QByteArray typeStr() const;

    Todo *clone() const;

    void setDtDue(const KDateTime &dtDue, bool first = false);

    KDateTime dtDue(bool first = false) const;

    bool hasDueDate() const;

    KCALCORE_DEPRECATED void setHasDueDate(bool hasDueDate);

    bool hasStartDate() const;

    KCALCORE_DEPRECATED void setHasStartDate(bool hasStartDate);

    virtual KDateTime dtStart() const;

    KDateTime dtStart(bool first) const;
 //TODO_KDE5: Remove (see IncidenceBase)
    void setDtStart(const KDateTime &dtStart);

    bool isCompleted() const;

    void setCompleted(bool completed);

    int percentComplete() const;

    void setPercentComplete(int percent);

    KDateTime completed() const;

    void setCompleted(const KDateTime &completeDate);

    bool hasCompletedDate() const;

    bool isInProgress(bool first) const;

    bool isOpenEnded() const;

    bool isNotStarted(bool first) const;

    virtual void shiftTimes(const KDateTime::Spec &oldSpec,
                            const KDateTime::Spec &newSpec);

    void setAllDay(bool allDay);

    void setDtRecurrence(const KDateTime &dt);

    KDateTime dtRecurrence() const;

    virtual bool recursOn(const QDate &date,
                          const KDateTime::Spec &timeSpec) const;

    bool isOverdue() 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 todoMimeType();

protected:
    virtual bool equals(const IncidenceBase &todo) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

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

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

    Todo &operator=(const Todo &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::Todo::Ptr, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KCalCore::Todo::Ptr)

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

#endif