-rw-r--r-- | libkcal/todo.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/libkcal/todo.h b/libkcal/todo.h index ab8fdf1..501c2ba 100644 --- a/libkcal/todo.h +++ b/libkcal/todo.h | |||
@@ -1,150 +1,151 @@ | |||
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 | ||
30 | namespace KCal { | 30 | namespace 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 | 45 | ||
45 | /** Return an exact copy of this todo. */ | 46 | /** Return an exact copy of this todo. */ |
46 | Incidence *clone(); | 47 | Incidence *clone(); |
47 | QDateTime getNextAlarmDateTime( bool * ok, int * offset, QDateTime start_dt ) const; | 48 | QDateTime getNextAlarmDateTime( bool * ok, int * offset, QDateTime start_dt ) const; |
48 | 49 | ||
49 | /** for setting the todo's due date/time with a QDateTime. */ | 50 | /** for setting the todo's due date/time with a QDateTime. */ |
50 | void setDtDue(const QDateTime &dtDue); | 51 | void setDtDue(const QDateTime &dtDue); |
51 | /** returns an event's Due date/time as a QDateTime. */ | 52 | /** returns an event's Due date/time as a QDateTime. */ |
52 | QDateTime dtDue() const; | 53 | QDateTime dtDue() const; |
53 | /** returns an event's due time as a string formatted according to the | 54 | /** returns an event's due time as a string formatted according to the |
54 | users locale settings */ | 55 | users locale settings */ |
55 | QString dtDueTimeStr() const; | 56 | QString dtDueTimeStr() const; |
56 | /** returns an event's due date as a string formatted according to the | 57 | /** returns an event's due date as a string formatted according to the |
57 | users locale settings */ | 58 | users locale settings */ |
58 | QString dtDueDateStr(bool shortfmt=true) const; | 59 | QString dtDueDateStr(bool shortfmt=true) const; |
59 | /** returns an event's due date and time as a string formatted according | 60 | /** returns an event's due date and time as a string formatted according |
60 | to the users locale settings */ | 61 | to the users locale settings */ |
61 | QString dtDueStr(bool shortfmt=true) const; | 62 | QString dtDueStr(bool shortfmt=true) const; |
62 | 63 | ||
63 | /** returns TRUE or FALSE depending on whether the todo has a due date */ | 64 | /** returns TRUE or FALSE depending on whether the todo has a due date */ |
64 | bool hasDueDate() const; | 65 | bool hasDueDate() const; |
65 | /** sets the event's hasDueDate value. */ | 66 | /** sets the event's hasDueDate value. */ |
66 | void setHasDueDate(bool f); | 67 | void setHasDueDate(bool f); |
67 | 68 | ||
68 | /* | 69 | /* |
69 | Looks for a subtodo (including itself ) which is not complete and is | 70 | Looks for a subtodo (including itself ) which is not complete and is |
70 | - overdue, or | 71 | - overdue, or |
71 | - due today. | 72 | - due today. |
72 | It returns 0 for nothing found, | 73 | It returns 0 for nothing found, |
73 | 1 for found a todo which is due today and no overdue found | 74 | 1 for found a todo which is due today and no overdue found |
74 | 2 for found a overdue todo | 75 | 2 for found a overdue todo |
75 | */ | 76 | */ |
76 | int hasDueSubTodo( bool checkSubtodos = true ); | 77 | int hasDueSubTodo( bool checkSubtodos = true ); |
77 | /* same as above, but a specific date can be specified*/ | 78 | /* same as above, but a specific date can be specified*/ |
78 | int hasDueSubTodoForDate( const QDate & date, bool checkSubtodos ); | 79 | int hasDueSubTodoForDate( const QDate & date, bool checkSubtodos ); |
79 | 80 | ||
80 | 81 | ||
81 | /** sets the event's status to the string specified. The string | 82 | /** sets the event's status to the string specified. The string |
82 | * must be a recognized value for the status field, i.e. a string | 83 | * must be a recognized value for the status field, i.e. a string |
83 | * equivalent of the possible status enumerations previously described. */ | 84 | * equivalent of the possible status enumerations previously described. */ |
84 | // void setStatus(const QString &statStr); | 85 | // void setStatus(const QString &statStr); |
85 | /** sets the event's status to the value specified. See the enumeration | 86 | /** sets the event's status to the value specified. See the enumeration |
86 | * above for possible values. */ | 87 | * above for possible values. */ |
87 | // void setStatus(int); | 88 | // void setStatus(int); |
88 | /** return the event's status. */ | 89 | /** return the event's status. */ |
89 | // int status() const; | 90 | // int status() const; |
90 | /** return the event's status in string format. */ | 91 | /** return the event's status in string format. */ |
91 | // QString statusStr() const; | 92 | // QString statusStr() const; |
92 | 93 | ||
93 | /** return, if this todo is completed */ | 94 | /** return, if this todo is completed */ |
94 | bool isCompleted() const; | 95 | bool isCompleted() const; |
95 | /** set completed state of this todo */ | 96 | /** set completed state of this todo */ |
96 | void setCompleted(bool); | 97 | void setCompleted(bool); |
97 | 98 | ||
98 | /** | 99 | /** |
99 | Return how many percent of the task are completed. Returns a value | 100 | Return how many percent of the task are completed. Returns a value |
100 | between 0 and 100. | 101 | between 0 and 100. |
101 | */ | 102 | */ |
102 | int percentComplete() const; | 103 | int percentComplete() const; |
103 | /** | 104 | /** |
104 | Set how many percent of the task are completed. Valid values are in the | 105 | Set how many percent of the task are completed. Valid values are in the |
105 | range from 0 to 100. | 106 | range from 0 to 100. |
106 | */ | 107 | */ |
107 | void setPercentComplete(int); | 108 | void setPercentComplete(int); |
108 | 109 | ||
109 | /** return date and time when todo was completed */ | 110 | /** return date and time when todo was completed */ |
110 | QDateTime completed() const; | 111 | QDateTime completed() const; |
111 | QString completedStr(bool shortF = true) const; | 112 | QString completedStr(bool shortF = true) const; |
112 | /** set date and time of completion */ | 113 | /** set date and time of completion */ |
113 | void setCompleted(const QDateTime &completed); | 114 | void setCompleted(const QDateTime &completed); |
114 | 115 | ||
115 | /** Return true, if todo has a date associated with completion */ | 116 | /** Return true, if todo has a date associated with completion */ |
116 | bool hasCompletedDate() const; | 117 | bool hasCompletedDate() const; |
117 | bool contains ( Todo*); | 118 | bool contains ( Todo*); |
118 | void checkSetCompletedFalse(); | 119 | void checkSetCompletedFalse(); |
119 | bool setRecurDates(); | 120 | bool setRecurDates(); |
120 | bool isRunning() {return mRunning;} | 121 | bool isRunning() {return mRunning;} |
121 | bool hasRunningSub(); | 122 | bool hasRunningSub(); |
122 | void setRunning( bool ); | 123 | void setRunning( bool ); |
123 | void setRunningFalse( QString ); | 124 | void setRunningFalse( QString ); |
124 | int runTime(); | 125 | int runTime(); |
125 | QDateTime runStart () const { return mRunStart;} | 126 | QDateTime runStart () const { return mRunStart;} |
126 | public slots: | 127 | public slots: |
127 | void saveRunningInfoToFile( QString st = QString::null ); | 128 | void saveRunningInfoToFile( QString st = QString::null ); |
128 | void saveParents(); | 129 | void saveParents(); |
129 | private: | 130 | private: |
130 | bool mRunning; | 131 | bool mRunning; |
131 | QTimer * mRunSaveTimer; | 132 | QTimer * mRunSaveTimer; |
132 | QDateTime mRunStart; | 133 | QDateTime mRunStart; |
133 | bool accept(Visitor &v) { return v.visit(this); } | 134 | bool accept(Visitor &v) { return v.visit(this); } |
134 | 135 | ||
135 | QDateTime mDtDue; // due date of todo | 136 | QDateTime mDtDue; // due date of todo |
136 | 137 | ||
137 | bool mHasDueDate; // if todo has associated due date | 138 | bool mHasDueDate; // if todo has associated due date |
138 | 139 | ||
139 | // int mStatus; // confirmed/delegated/tentative/etc | 140 | // int mStatus; // confirmed/delegated/tentative/etc |
140 | 141 | ||
141 | QDateTime mCompleted; | 142 | QDateTime mCompleted; |
142 | bool mHasCompletedDate; | 143 | bool mHasCompletedDate; |
143 | 144 | ||
144 | int mPercentComplete; | 145 | int mPercentComplete; |
145 | }; | 146 | }; |
146 | 147 | ||
147 | bool operator==( const Todo&, const Todo& ); | 148 | bool operator==( const Todo&, const Todo& ); |
148 | } | 149 | } |
149 | 150 | ||
150 | #endif | 151 | #endif |