summaryrefslogtreecommitdiffabout
path: root/libkcal/todo.h
Unidiff
Diffstat (limited to 'libkcal/todo.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/todo.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/libkcal/todo.h b/libkcal/todo.h
index 42db025..11f848e 100644
--- a/libkcal/todo.h
+++ b/libkcal/todo.h
@@ -1,153 +1,155 @@
1/* 1/*
2 This file is part of libkcal. 2 This file is part of libkcal.
3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> 3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
4 4
5 This library is free software; you can redistribute it and/or 5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public 6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either 7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version. 8 version 2 of the License, or (at your option) any later version.
9 9
10 This library is distributed in the hope that it will be useful, 10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details. 13 Library General Public License for more details.
14 14
15 You should have received a copy of the GNU Library General Public License 15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to 16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. 18 Boston, MA 02111-1307, USA.
19*/ 19*/
20#ifndef TODO_H 20#ifndef TODO_H
21#define TODO_H 21#define TODO_H
22// 22//
23// Todo component, representing a VTODO object 23// Todo component, representing a VTODO object
24// 24//
25 25
26#include "incidence.h" 26#include "incidence.h"
27 27
28#include <qtimer.h> 28#include <qtimer.h>
29 29
30namespace KCal { 30namespace KCal {
31 31
32/** 32/**
33 This class provides a Todo in the sense of RFC2445. 33 This class provides a Todo in the sense of RFC2445.
34*/ 34*/
35 class Todo : public QObject,public Incidence 35 class Todo : public QObject,public Incidence
36{ 36{
37 Q_OBJECT 37 Q_OBJECT
38 public: 38 public:
39 Todo(); 39 Todo();
40 Todo(const Todo &); 40 Todo(const Todo &);
41 ~Todo(); 41 ~Todo();
42 typedef ListBase<Todo> List; 42 typedef ListBase<Todo> List;
43 QCString type() const { return "Todo"; } 43 QCString type() const { return "Todo"; }
44 IncTypeID typeID() const { return todoID; } 44 IncTypeID typeID() const { return todoID; }
45 void saveRunningInfo( QString comment, QDateTime start, QDateTime end );
45 46
46 /** Return an exact copy of this todo. */ 47 /** Return an exact copy of this todo. */
47 Incidence *clone(); 48 Incidence *clone();
48 QDateTime getNextAlarmDateTime( bool * ok, int * offset, QDateTime start_dt ) const; 49 QDateTime getNextAlarmDateTime( bool * ok, int * offset, QDateTime start_dt ) const;
49 50
50 /** for setting the todo's due date/time with a QDateTime. */ 51 /** for setting the todo's due date/time with a QDateTime. */
51 void setDtDue(const QDateTime &dtDue); 52 void setDtDue(const QDateTime &dtDue);
52 /** returns an event's Due date/time as a QDateTime. */ 53 /** returns an event's Due date/time as a QDateTime. */
53 QDateTime dtDue() const; 54 QDateTime dtDue() const;
54 /** returns an event's due time as a string formatted according to the 55 /** returns an event's due time as a string formatted according to the
55 users locale settings */ 56 users locale settings */
56 QString dtDueTimeStr() const; 57 QString dtDueTimeStr() const;
57 /** returns an event's due date as a string formatted according to the 58 /** returns an event's due date as a string formatted according to the
58 users locale settings */ 59 users locale settings */
59 QString dtDueDateStr(bool shortfmt=true) const; 60 QString dtDueDateStr(bool shortfmt=true) const;
60 /** returns an event's due date and time as a string formatted according 61 /** returns an event's due date and time as a string formatted according
61 to the users locale settings */ 62 to the users locale settings */
62 QString dtDueStr(bool shortfmt=true) const; 63 QString dtDueStr(bool shortfmt=true) const;
63 64
64 /** returns TRUE or FALSE depending on whether the todo has a due date */ 65 /** returns TRUE or FALSE depending on whether the todo has a due date */
65 bool hasDueDate() const; 66 bool hasDueDate() const;
66 /** sets the event's hasDueDate value. */ 67 /** sets the event's hasDueDate value. */
67 void setHasDueDate(bool f); 68 void setHasDueDate(bool f);
68 69
69 /* 70 /*
70 Looks for a subtodo (including itself ) which is not complete and is 71 Looks for a subtodo (including itself ) which is not complete and is
71 - overdue, or 72 - overdue, or
72 - due today. 73 - due today.
73 It returns 0 for nothing found, 74 It returns 0 for nothing found,
74 1 for found a todo which is due today and no overdue found 75 1 for found a todo which is due today and no overdue found
75 2 for found a overdue todo 76 2 for found a overdue todo
76 */ 77 */
77 int hasDueSubTodo( bool checkSubtodos = true ); 78 int hasDueSubTodo( bool checkSubtodos = true );
78 /* same as above, but a specific date can be specified*/ 79 /* same as above, but a specific date can be specified*/
79 int hasDueSubTodoForDate( const QDate & date, bool checkSubtodos ); 80 int hasDueSubTodoForDate( const QDate & date, bool checkSubtodos );
80 81
81 82
82 /** sets the event's status to the string specified. The string 83 /** sets the event's status to the string specified. The string
83 * must be a recognized value for the status field, i.e. a string 84 * must be a recognized value for the status field, i.e. a string
84 * equivalent of the possible status enumerations previously described. */ 85 * equivalent of the possible status enumerations previously described. */
85// void setStatus(const QString &statStr); 86// void setStatus(const QString &statStr);
86 /** sets the event's status to the value specified. See the enumeration 87 /** sets the event's status to the value specified. See the enumeration
87 * above for possible values. */ 88 * above for possible values. */
88// void setStatus(int); 89// void setStatus(int);
89 /** return the event's status. */ 90 /** return the event's status. */
90// int status() const; 91// int status() const;
91 /** return the event's status in string format. */ 92 /** return the event's status in string format. */
92// QString statusStr() const; 93// QString statusStr() const;
93 94
94 /** return, if this todo is completed */ 95 /** return, if this todo is completed */
95 bool isCompleted() const; 96 bool isCompleted() const;
96 /** set completed state of this todo */ 97 /** set completed state of this todo */
97 void setCompleted(bool); 98 void setCompleted(bool);
98 99
99 /** 100 /**
100 Return how many percent of the task are completed. Returns a value 101 Return how many percent of the task are completed. Returns a value
101 between 0 and 100. 102 between 0 and 100.
102 */ 103 */
103 int percentComplete() const; 104 int percentComplete() const;
104 /** 105 /**
105 Set how many percent of the task are completed. Valid values are in the 106 Set how many percent of the task are completed. Valid values are in the
106 range from 0 to 100. 107 range from 0 to 100.
107 */ 108 */
108 void setPercentComplete(int); 109 void setPercentComplete(int);
109 110
110 /** return date and time when todo was completed */ 111 /** return date and time when todo was completed */
111 QDateTime completed() const; 112 QDateTime completed() const;
112 QString completedStr(bool shortF = true) const; 113 QString completedStr(bool shortF = true) const;
113 /** set date and time of completion */ 114 /** set date and time of completion */
114 void setCompleted(const QDateTime &completed); 115 void setCompleted(const QDateTime &completed);
115 116
116 /** Return true, if todo has a date associated with completion */ 117 /** Return true, if todo has a date associated with completion */
117 bool hasCompletedDate() const; 118 bool hasCompletedDate() const;
118 bool contains ( Todo*); 119 bool contains ( Todo*);
119 void checkSetCompletedFalse(); 120 void checkSetCompletedFalse();
120 bool setRecurDates(); 121 bool setRecurDates();
121 bool isRunning() {return mRunning;} 122 bool isRunning() {return mRunning;}
122 bool hasRunningSub(); 123 bool hasRunningSub();
123 void setRunning( bool ); 124 void setRunning( bool );
124 void setRunningFalse( QString ); 125 void setRunningFalse( QString );
125 void stopRunning(); 126 void stopRunning();
126 int runTime(); 127 int runTime();
127 QDateTime runStart () const { return mRunStart;} 128 QDateTime runStart () const { return mRunStart;}
128 public slots: 129 public slots:
129 void saveRunningInfoToFile( QString st ); 130 void saveRunningInfoToFile( QString st );
130 void saveRunningInfoToFile( ); 131 void saveRunningInfoToFile( );
131 void saveParents(); 132 void saveParents();
132 private: 133 private:
133 bool mRunning; 134 bool mRunning;
134 QTimer * mRunSaveTimer; 135 QTimer * mRunSaveTimer;
135 QDateTime mRunStart; 136 QDateTime mRunStart;
137 QDateTime mRunEnd;
136 bool accept(Visitor &v) { return v.visit(this); } 138 bool accept(Visitor &v) { return v.visit(this); }
137 139
138 QDateTime mDtDue; // due date of todo 140 QDateTime mDtDue; // due date of todo
139 141
140 bool mHasDueDate; // if todo has associated due date 142 bool mHasDueDate; // if todo has associated due date
141 143
142// int mStatus; // confirmed/delegated/tentative/etc 144// int mStatus; // confirmed/delegated/tentative/etc
143 145
144 QDateTime mCompleted; 146 QDateTime mCompleted;
145 bool mHasCompletedDate; 147 bool mHasCompletedDate;
146 148
147 int mPercentComplete; 149 int mPercentComplete;
148}; 150};
149 151
150 bool operator==( const Todo&, const Todo& ); 152 bool operator==( const Todo&, const Todo& );
151} 153}
152 154
153#endif 155#endif