todo.h

Go to the documentation of this file.

/*
  This file is part of the kcal 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 KCAL_TODO_H
#define KCAL_TODO_H

#include "incidence.h"
#include <kpimutils/supertrait.h>
#include <QtCore/QByteArray>

namespace KCal {

class KCAL_DEPRECATED_EXPORT Todo : public Incidence
{
  public:
    typedef ListBase<Todo> List;

    typedef boost::shared_ptr<Todo> Ptr;

    typedef boost::shared_ptr<const Todo> ConstPtr;

    Todo();

    Todo( const Todo &other );

    ~Todo();

    QByteArray type() const;

    //KDE5: QString typeStr() const;

    Todo *clone();

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

    KDateTime dtDue( bool first = false ) const;

    KCAL_DEPRECATED QString dtDueTimeStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtDueDateStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtDueStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    bool hasDueDate() const;

    void setHasDueDate( bool hasDueDate );

    bool hasStartDate() const;

    void setHasStartDate( bool hasStartDate );

    virtual KDateTime dtStart() const;

    KDateTime dtStart( bool first ) const;

    void setDtStart( const KDateTime &dtStart );

    KCAL_DEPRECATED QString dtStartTimeStr(
      bool shortfmt, bool first, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual KCAL_DEPRECATED QString dtStartTimeStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtStartDateStr(
      bool shortfmt, bool first, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual KCAL_DEPRECATED QString dtStartDateStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    KCAL_DEPRECATED QString dtStartStr(
      bool shortfmt, bool first, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual KCAL_DEPRECATED QString dtStartStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    bool isCompleted() const;

    void setCompleted( bool completed );

    int percentComplete() const;

    void setPercentComplete( int percent );

    KDateTime completed() const;

    QString completedStr( bool shortfmt = false ) 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 setDtRecurrence( const KDateTime &dt );

    KDateTime dtRecurrence() const;

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

    bool isOverdue() const;

    Todo &operator=( const Todo &other );

    bool operator==( const Todo &todo ) const;

  protected:
    virtual KDateTime endDateRecurrenceBase() const;

  private:
    bool accept( Visitor &v ) { return v.visit( this ); }

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

}

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

#endif