summaryrefslogtreecommitdiffabout
path: root/libkcal/event.h
authorzautrix <zautrix>2004-06-26 19:01:18 (UTC)
committer zautrix <zautrix>2004-06-26 19:01:18 (UTC)
commitb9aad1f15dc600e4dbe4c62d3fcced6363188ba3 (patch) (unidiff)
tree2c3d4004fb21c72cba65793859f9bcd8ffd3a49c /libkcal/event.h
downloadkdepimpi-b9aad1f15dc600e4dbe4c62d3fcced6363188ba3.zip
kdepimpi-b9aad1f15dc600e4dbe4c62d3fcced6363188ba3.tar.gz
kdepimpi-b9aad1f15dc600e4dbe4c62d3fcced6363188ba3.tar.bz2
Initial revision
Diffstat (limited to 'libkcal/event.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/event.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/libkcal/event.h b/libkcal/event.h
new file mode 100644
index 0000000..2a8bd95
--- a/dev/null
+++ b/libkcal/event.h
@@ -0,0 +1,88 @@
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
21#ifndef EVENT_H
22#define EVENT_H
23//
24// Event component, representing a VEVENT object
25//
26
27#include "incidence.h"
28namespace KCal {
29
30/**
31 This class provides an Event in the sense of RFC2445.
32*/
33class Event : public Incidence
34{
35 public:
36 enum Transparency { Opaque, Transparent };
37 typedef ListBase<Event> List;
38 Event();
39 Event(const Event &);
40 ~Event();
41
42 QCString type() const { return "Event"; }
43
44 Incidence *clone();
45 QDateTime getNextAlarmDateTime( bool * ok, int * offset ) const;
46
47 /** for setting an event's ending date/time with a QDateTime. */
48 void setDtEnd(const QDateTime &dtEnd);
49 /** Return the event's ending date/time as a QDateTime. */
50 virtual QDateTime dtEnd() const;
51 /** returns an event's end time as a string formatted according to the
52 users locale settings */
53 QString dtEndTimeStr() const;
54 /** returns an event's end date as a string formatted according to the
55 users locale settings */
56 QString dtEndDateStr(bool shortfmt=true) const;
57 /** returns an event's end date and time as a string formatted according
58 to the users locale settings */
59 QString dtEndStr(bool shortfmt=true) const;
60 void setHasEndDate(bool);
61 /** Return whether the event has an end date/time. */
62 bool hasEndDate() const;
63
64 /** Return true if the event spans multiple days, otherwise return false. */
65 bool isMultiDay() const;
66
67 /** set the event's time transparency level. */
68 void setTransparency(Transparency transparency);
69 /** get the event's time transparency level. */
70 Transparency transparency() const;
71
72 void setDuration(int seconds);
73
74 private:
75 bool accept(Visitor &v) { return v.visit(this); }
76
77 QDateTime mDtEnd;
78 bool mHasEndDate;
79 Transparency mTransparency;
80};
81
82bool operator==( const Event&, const Event& );
83
84
85}
86
87
88#endif