1/*
2 This file is part of libkabc.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KABC_TIMEZONE_H
22#define KABC_TIMEZONE_H
23
24#include "kabc_export.h"
25#include <QtCore/QSharedDataPointer>
26#include <QtCore/QString>
27
28namespace KABC {
29
30/**
31 * @short Time zone information.
32 *
33 * This class stores information about a time zone.
34 */
35class KABC_EXPORT TimeZone
36{
37 friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const TimeZone & );
38 friend KABC_EXPORT QDataStream &operator>>( QDataStream &, TimeZone & );
39
40 public:
41 /**
42 * Construct invalid time zone.
43 */
44 TimeZone();
45
46 /**
47 * Construct time zone.
48 *
49 * @param offset Offset in minutes relative to UTC.
50 */
51 TimeZone( int offset );
52
53 /**
54 * Copy constructor.
55 */
56 TimeZone( const TimeZone &other );
57
58 /**
59 * Destroys the time zone.
60 */
61 ~TimeZone();
62
63 /**
64 * Set time zone offset relative to UTC.
65 *
66 * @param offset Offset in minutes.
67 */
68 void setOffset( int offset );
69
70 /**
71 * Return offset in minutes relative to UTC.
72 */
73 int offset() const;
74
75 /**
76 * Return, if this time zone object is valid.
77 */
78 bool isValid() const;
79
80 bool operator==( const TimeZone & ) const;
81 bool operator!=( const TimeZone & ) const;
82 TimeZone &operator=( const TimeZone &other );
83
84 /**
85 * Return string representation of time zone offset.
86 */
87 QString toString() const;
88
89 private:
90 class Private;
91 QSharedDataPointer<Private> d;
92};
93
94/**
95 * Serializes the @p timezone object into the @p stream.
96 */
97KABC_EXPORT QDataStream &operator<<( QDataStream &stream, const TimeZone &timeZone );
98
99/**
100 * Initializes the @p timezone object from the @p stream.
101 */
102KABC_EXPORT QDataStream &operator>>( QDataStream &stream, TimeZone &timeZone );
103
104}
105
106#endif
107