summaryrefslogtreecommitdiffabout
path: root/libkcal/todo.h
Unidiff
Diffstat (limited to 'libkcal/todo.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/todo.h121
1 files changed, 121 insertions, 0 deletions
diff --git a/libkcal/todo.h b/libkcal/todo.h
new file mode 100644
index 0000000..9aa92f8
--- a/dev/null
+++ b/libkcal/todo.h
@@ -0,0 +1,121 @@
1/*
2 This file is part of libkcal.
3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
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
17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
19*/
20#ifndef TODO_H
21#define TODO_H
22//
23// Todo component, representing a VTODO object
24//
25
26#include "incidence.h"
27
28namespace KCal {
29
30/**
31 This class provides a Todo in the sense of RFC2445.
32*/
33class Todo : public Incidence
34{
35 public:
36 Todo();
37 Todo(const Todo &);
38 ~Todo();
39 typedef ListBase<Todo> List;
40 QCString type() const { return "Todo"; }
41
42 /** Return an exact copy of this todo. */
43 Incidence *clone();
44 QDateTime getNextAlarmDateTime( bool * ok, int * offset ) const;
45
46 /** for setting the todo's due date/time with a QDateTime. */
47 void setDtDue(const QDateTime &dtDue);
48 /** returns an event's Due date/time as a QDateTime. */
49 QDateTime dtDue() const;
50 /** returns an event's due time as a string formatted according to the
51 users locale settings */
52 QString dtDueTimeStr() const;
53 /** returns an event's due date as a string formatted according to the
54 users locale settings */
55 QString dtDueDateStr(bool shortfmt=true) const;
56 /** returns an event's due date and time as a string formatted according
57 to the users locale settings */
58 QString dtDueStr(bool shortfmt=true) const;
59
60 /** returns TRUE or FALSE depending on whether the todo has a due date */
61 bool hasDueDate() const;
62 /** sets the event's hasDueDate value. */
63 void setHasDueDate(bool f);
64
65
66 /** sets the event's status to the string specified. The string
67 * must be a recognized value for the status field, i.e. a string
68 * equivalent of the possible status enumerations previously described. */
69// void setStatus(const QString &statStr);
70 /** sets the event's status to the value specified. See the enumeration
71 * above for possible values. */
72// void setStatus(int);
73 /** return the event's status. */
74// int status() const;
75 /** return the event's status in string format. */
76// QString statusStr() const;
77
78 /** return, if this todo is completed */
79 bool isCompleted() const;
80 /** set completed state of this todo */
81 void setCompleted(bool);
82
83 /**
84 Return how many percent of the task are completed. Returns a value
85 between 0 and 100.
86 */
87 int percentComplete() const;
88 /**
89 Set how many percent of the task are completed. Valid values are in the
90 range from 0 to 100.
91 */
92 void setPercentComplete(int);
93
94 /** return date and time when todo was completed */
95 QDateTime completed() const;
96 QString completedStr() const;
97 /** set date and time of completion */
98 void setCompleted(const QDateTime &completed);
99
100 /** Return true, if todo has a date associated with completion */
101 bool hasCompletedDate() const;
102
103 private:
104 bool accept(Visitor &v) { return v.visit(this); }
105
106 QDateTime mDtDue; // due date of todo
107
108 bool mHasDueDate; // if todo has associated due date
109
110// int mStatus; // confirmed/delegated/tentative/etc
111
112 QDateTime mCompleted;
113 bool mHasCompletedDate;
114
115 int mPercentComplete;
116};
117
118 bool operator==( const Todo&, const Todo& );
119}
120
121#endif