libkcal

todo.h

00001 /*
00002     This file is part of libkcal.
00003 
00004     Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
00005 
00006     This library is free software; you can redistribute it and/or
00007     modify it under the terms of the GNU Library General Public
00008     License as published by the Free Software Foundation; either
00009     version 2 of the License, or (at your option) any later version.
00010 
00011     This library is distributed in the hope that it will be useful,
00012     but WITHOUT ANY WARRANTY; without even the implied warranty of
00013     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014     Library General Public License for more details.
00015 
00016     You should have received a copy of the GNU Library General Public License
00017     along with this library; see the file COPYING.LIB.  If not, write to
00018     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00019     Boston, MA 02110-1301, USA.
00020 */
00021 #ifndef KCAL_TODO_H
00022 #define KCAL_TODO_H
00023 
00024 #include "incidence.h"
00025 
00026 namespace KCal {
00027 
00031 class LIBKCAL_EXPORT Todo : public Incidence
00032 {
00033   public:
00034     typedef ListBase<Todo> List;
00035 
00036     Todo();
00037     Todo( const Todo & );
00038     ~Todo();
00039     Todo& operator=( const Todo& );
00040     bool operator==( const Todo& ) const;
00041 
00042     QCString type() const { return "Todo"; }
00043 
00048     Todo *clone();
00049 
00056     void setDtDue(const QDateTime &dtDue, bool first = false);
00065     QDateTime dtDue( bool first = false ) const;
00071     KDE_DEPRECATED QString dtDueTimeStr() const;
00072 
00081     KDE_DEPRECATED QString dtDueDateStr( bool shortfmt = true ) const;
00082 
00088     KDE_DEPRECATED QString dtDueStr() const;
00089 
00093     bool hasDueDate() const;
00099     void setHasDueDate( bool hasDueDate );
00100 
00104     bool hasStartDate() const;
00110     void setHasStartDate( bool hasStartDate );
00111 
00119     QDateTime dtStart( bool first = false ) const;
00120 
00124     void setDtStart( const QDateTime &dtStart );
00125 
00133     QString dtStartTimeStr( bool first = false ) const;
00143     QString dtStartDateStr( bool shortfmt = true, bool first = false ) const;
00151     QString dtStartStr( bool first = false ) const;
00152 
00156     bool isCompleted() const;
00163     void setCompleted( bool completed );
00164 
00169     int percentComplete() const;
00174     void setPercentComplete( int );
00175 
00179     QDateTime completed() const;
00184     QString completedStr() const;
00188     void setCompleted( const QDateTime &completed );
00189 
00194     bool hasCompletedDate() const;
00195 
00199     void setDtRecurrence( const QDateTime &dt );
00200 
00204     QDateTime dtRecurrence() const;
00205 
00212     virtual bool recursOn( const QDate &date ) const;
00213 
00218       bool isOverdue() const;
00219 
00220   protected:
00222     virtual QDateTime endDateRecurrenceBase() const { return dtDue(); }
00223 
00224   private:
00225     bool accept(Visitor &v) { return v.visit( this ); }
00226 
00234     bool recurTodo();
00235 
00236     QDateTime mDtDue;                    // due date of todo
00237                                          // (first occurrence if recurrent)
00238     QDateTime mDtRecurrence;             // due date of recurrence
00239 
00240     bool mHasDueDate;                    // if todo has associated due date
00241     bool mHasStartDate;                  // if todo has associated start date
00242 
00243     QDateTime mCompleted;
00244     bool mHasCompletedDate;
00245 
00246     int mPercentComplete;
00247 
00248     class Private;
00249     Private *d;
00250 };
00251 
00252 }
00253 
00254 #endif
KDE Home | KDE Accessibility Home | Description of Access Keys