summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/core/opimevent.h
blob: 1d1253068d69bdda358e9c3012646bec676dfd11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*
                             This file is part of the Opie Project
                             Copyright (C) Stefan Eilers <Eilers.Stefan@epost.de>
              =.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
            .=l.
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
.> <`_,   >  .   <=          redistribute it and/or  modify it under
:`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
.="- .-=="i,     .._         License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       This program is distributed in the hope that
     +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
    : ..    .:,     . . .    without even the implied warranty of
    =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
  _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
..}^=.=       =       ;      Library General Public License for more
++=   -.     .`     .:       details.
 :     =  ...= . :.=-
 -.   .:....=;==+<;          You should have received a copy of the GNU
  -_. . .   )=.  =           Library General Public License along with
    --        :-=`           this library; see the file COPYING.LIB.
                             If not, write to the Free Software Foundation,
                             Inc., 59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.
*/
// CONTAINS GPLed code of TT

#ifndef OEVENT_H
#define OEVENT_H

/* OPIE */
#include <opie2/opimtimezone.h>
#include <opie2/opimrecord.h>
#include <qpe/recordfields.h>
#include <qpe/palmtopuidgen.h>

/* QT */
#include <qstring.h>
#include <qdatetime.h>
#include <qvaluelist.h>

namespace Opie
{
struct OCalendarHelper
{
    /** calculate the week number of the date */
    static int week( const QDate& );
    /** calculate the occurence of week days since the start of the month */
    static int ocurrence( const QDate& );

    // returns the dayOfWeek for the *first* day it finds (ignores
    // any further days!). Returns 1 (Monday) if there isn't any day found
    static int dayOfWeek( char day );

    /** returns the diff of month */
    static int monthDiff( const QDate& first, const QDate& second );

};

class OPimNotifyManager;
class OPimRecurrence;

/**
 * This is the container for all Events. It encapsules all
 * available information for a single Event
 * @short container for events.
 */
class OPimEvent : public OPimRecord
{
  public:
    typedef QValueList<OPimEvent> ValueList;
    /**
     * RecordFields contain possible attributes
     * used in the Results of toMap()..
     */
    enum RecordFields {
        FUid = Qtopia::UID_ID,
        FCategories = Qtopia::CATEGORY_ID,
        FDescription /* = 0 Why this ? (eilers) */,
        FLocation,
        FType,
        FAlarm,
        FSound,
        FRType,
        FRWeekdays,
        FRPosition,
        FRFreq,
        FRHasEndDate,
        FREndDate,
        FRCreated,
        FRExceptions,
        FStart,
        FEnd,
        FNote,
        FTimeZone,
        FRecParent,
        FRecChildren,
    };

    /**
     * Start with an Empty OPimEvent. UID == 0 means that it is empty
     */
    OPimEvent( int uid = 0 );

    /**
     * copy c'tor
     */
    OPimEvent( const OPimEvent& );

    /**
     * Create OPimEvent, initialized by map
     * @see enum RecordFields
     */
    OPimEvent( const QMap<int, QString> map );
    ~OPimEvent();
    OPimEvent &operator=( const OPimEvent& );

    //@{
    QString description() const;
    void setDescription( const QString& description );

    QString location() const;
    void setLocation( const QString& loc );
    //@}

    //@{
    bool hasNotifiers() const;
    OPimNotifyManager &notifiers() const;
    //@}

    //@{
    OPimRecurrence recurrence() const;
    void setRecurrence( const OPimRecurrence& );
    bool hasRecurrence() const;
    //@}

    //@{
    QString note() const;
    void setNote( const QString& note );
    //@}


    QDateTime createdDateTime() const;
    void setCreatedDateTime( const QDateTime& dt );

    /** set the date to dt. dt is the QDateTime in localtime */
    void setStartDateTime( const QDateTime& );
    /** returns the datetime in the local timeZone */
    QDateTime startDateTime() const;

    /** returns the start datetime in the current zone */
    QDateTime startDateTimeInZone() const;

    /** in current timezone */
    void setEndDateTime( const QDateTime& );
    /** in current timezone */
    QDateTime endDateTime() const;
    QDateTime endDateTimeInZone() const;

    bool isMultipleDay() const;
    bool isAllDay() const;
    void setAllDay( bool isAllDay );

    /* pin this event to a timezone! FIXME */
    void setTimeZone( const QString& timeZone );
    QString timeZone() const;


    //@{
    /** For exception to recurrence here is a list of children...  */
    QArray<int> children() const;
    void setChildren( const QArray<int>& );
    void addChild( int uid );
    void removeChild( int uid );
    //@}

    /** return the parent OPimEvent */
    int parent() const;
    void setParent( int uid );


    /* needed reimp */
    //@{ Reimplementations
    virtual bool match( const QRegExp& ) const;
    QString toRichText() const;
    QString toShortText() const;
    QString type() const;

    QMap<int, QString> toMap() const;
    void fromMap( const QMap<int, QString>& map );
    QString recordField( int ) const;

    bool loadFromStream( QDataStream& );
    bool saveToStream( QDataStream& ) const;
    //@}

    //@{
    int rtti() const;
    static OPimEvent* safeCast( const OPimRecord* );
    //@}

  /*    bool operator==( const OPimEvent& );
        bool operator!=( const OPimEvent& );
        bool operator<( const OPimEvent& );
        bool operator<=( const OPimEvent& );
        bool operator>( const OPimEvent& );
        bool operator>=(const OPimEvent& );
    */

  private:
    inline void changeOrModify();
    void deref();
    struct Data;
    Data* data;
    class Private;
    Private* priv;

};
}

#endif