/usr/include/kcal/period.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
This file is part of the kcal library.
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
@file
This file is part of the API for handling calendar data and
defines the Period class.
@brief
Represents a period of time.
@author Cornelius Schumacher \<schumacher@kde.org\>
*/
#ifndef KCAL_PERIOD_H
#define KCAL_PERIOD_H
#include "kcal_export.h"
#include "duration.h"
#include <kdatetime.h>
#include <QtCore/QList>
namespace KCal {
/**
The period can be defined by either a start time and an end time or
by a start time and a duration.
*/
class KCAL_EXPORT_DEPRECATED Period
{
public:
/**
List of periods.
*/
typedef QList<Period> List;
/**
Constructs a period without a duration.
*/
Period();
/**
Constructs a period from @p start to @p end.
@param start the time the period begins.
@param end the time the period ends.
*/
Period( const KDateTime &start, const KDateTime &end );
/**
Constructs a period from @p start and lasting @p duration.
@param start the time when the period starts.
@param duration how long the period lasts.
*/
Period( const KDateTime &start, const Duration &duration );
/**
Constructs a period by copying another period object
@param period the period to copy
*/
Period( const Period &period );
/**
Destroys a period.
*/
~Period();
/**
Returns true if the start of this period is earlier than the start of
the @p other one.
@param other is the other period to compare.
*/
bool operator<( const Period &other ) const;
/**
Returns true if the start of this period is later than the start of
the @p other one.
@param other the other period to compare
*/
bool operator>( const Period &other ) const { return other.operator<( *this ); }
/**
Returns true if this period is equal to the @p other one.
Even if their start and end times are the same, two periods are
considered not equal if one is defined in terms of a duration and the
other in terms of a start and end time.
@param other the other period to compare
*/
bool operator==( const Period &other ) const;
/**
Returns true if this period is not equal to the @p other one.
@param other the other period to compare
@see operator==()
*/
bool operator!=( const Period &other ) const { return !operator==( other ); }
/**
Sets this period equal to the @p other one.
@param other is the other period to compare.
*/
Period &operator=( const Period &other );
/**
Returns when this period starts.
*/
KDateTime start() const;
/**
Returns when this period ends.
*/
KDateTime end() const;
/**
Returns the duration of the period.
If the period is defined in terms of a start and end time, the duration
is computed from these. In this case, if the time of day in @p start and
@p end is equal, and their time specifications (i.e. time zone etc.) are
the same, the duration will be set in terms of days. Otherwise, the
duration will be set in terms of seconds.
If the period is defined in terms of a duration, that duration is
returned unchanged.
*/
Duration duration() const;
/**
Returns the duration of the period.
If the period is defined in terms of a start and end time, the duration
is first computed from these.
If @p type is Days, and the duration is not an exact number of days,
the duration will be rounded down to the nearest whole number of days.
@param type the unit of time to use (seconds or days)
*/
Duration duration( Duration::Type type ) const;
/**
Returns true if this period has a set duration, false
if it just has a start and an end.
*/
bool hasDuration() const;
/**
Shift the times of the period so that they appear at the same clock
time as before but in a new time zone. The shift is done from a viewing
time zone rather than from the actual period time zone.
For example, shifting a period whose start time is 09:00 America/New York,
using an old viewing time zone (@p oldSpec) of Europe/London, to a new
time zone (@p newSpec) of Europe/Paris, will result in the time being
shifted from 14:00 (which is the London time of the period start) to
14:00 Paris time.
@param oldSpec the time specification which provides the clock times
@param newSpec the new time specification
*/
void shiftTimes( const KDateTime::Spec &oldSpec,
const KDateTime::Spec &newSpec );
private:
//@cond PRIVATE
class Private;
Private *const d;
//@endcond
};
}
#endif
|