/usr/include/kalarmcal/repetition.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
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 | /*
* repetition.h - represents a sub-repetition: interval and count
* This file is part of kalarmcal library, which provides access to KAlarm
* calendar data.
* Copyright © 2009-2012 by David Jarvie <djarvie@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.
*/
#ifndef KALARM_REPETITION_H
#define KALARM_REPETITION_H
#include "kalarmcal_export.h"
#ifndef KALARMCAL_USE_KRESOURCES
#include <kcalcore/duration.h>
#else
#include <kcal/duration.h>
#endif
class KDateTime;
namespace KAlarmCal
{
/**
* @short Represents a sub-repetition, defined by interval and repeat count.
*
* The Repetition class represents a sub-repetition, storing its interval
* and repeat count. The repeat count is the number of repetitions after
* the first occurrence.
*
* @author David Jarvie <djarvie@kde.org>
*/
class KALARMCAL_EXPORT Repetition
{
public:
/** Default constructor.
* Initialises to no repetition.
*/
Repetition();
#ifndef KALARMCAL_USE_KRESOURCES
/** Constructor.
* Initialises with the specified @p interval and @p count.
*/
Repetition(const KCalCore::Duration& interval, int count);
#else
/** Constructor.
* Initialises with the specified @p interval and @p count.
*/
Repetition(const KCal::Duration& interval, int count);
#endif
Repetition(const Repetition& other);
~Repetition();
Repetition& operator=(const Repetition& other);
#ifndef KALARMCAL_USE_KRESOURCES
/** Initialises the instance with the specified @p interval and @p count. */
void set(const KCalCore::Duration& interval, int count);
#else
/** Initialises the instance with the specified @p interval and @p count. */
void set(const KCal::Duration& interval, int count);
#endif
#ifndef KALARMCAL_USE_KRESOURCES
/** Sets the @p interval. The repetition count is unchanged unless
* The repetition count is set to zero if @p interval is zero; otherwise
* the repetition count is unchanged.
*/
void set(const KCalCore::Duration& interval);
#else
/** Sets the @p interval. The repetition count is unchanged unless
* The repetition count is set to zero if @p interval is zero; otherwise
* the repetition count is unchanged.
*/
void set(const KCal::Duration& interval);
#endif
/** Returns whether a repetition is defined.
* @return true if a repetition is defined, false if not.
*/
operator bool() const;
/** Returns whether no repetition is defined.
* @return false if a repetition is defined, true if not.
*/
bool operator!() const { return !operator bool(); }
bool operator==(const Repetition& r) const;
bool operator!=(const Repetition& r) const { return !operator==(r); }
/** Return the number of repetitions. */
int count() const;
#ifndef KALARMCAL_USE_KRESOURCES
/** Return the interval between repetitions. */
KCalCore::Duration interval() const;
/** Return the overall duration of the repetition. */
KCalCore::Duration duration() const;
/** Return the overall duration of a specified number of repetitions.
* @param count the number of repetitions to find the duration of.
*/
KCalCore::Duration duration(int count) const;
#else
/** Return the interval between repetitions. */
KCal::Duration interval() const;
/** Return the overall duration of the repetition. */
KCal::Duration duration() const;
/** Return the overall duration of a specified number of repetitions.
* @param count the number of repetitions to find the duration of.
*/
KCal::Duration duration(int count) const;
#endif
/** Check whether the repetition interval is in terms of days (as opposed to minutes). */
bool isDaily() const;
/** Return the repetition interval in terms of days.
* If necessary, the interval is rounded down to a whole number of days.
*/
int intervalDays() const;
/** Return the repetition interval in terms of minutes.
* If necessary, the interval is rounded down to a whole number of minutes.
*/
int intervalMinutes() const;
/** Return the repetition interval in terms of seconds. */
int intervalSeconds() const;
/** Find the repetition count for the next repetition after a specified time.
* @param from repetition start time, which should not be a date-only value
* @param preDateTime time after which the desired repetition occurs
*/
int nextRepeatCount(const KDateTime& from, const KDateTime& preDateTime) const;
/** Find the repetition count for the last repetition before a specified time.
* @param from repetition start time, which should not be a date-only value
* @param afterDateTime time after which the desired repetition occurs
*/
int previousRepeatCount(const KDateTime& from, const KDateTime& afterDateTime) const;
private:
//@cond PRIVATE
class Private;
Private* const d;
//@endcond
};
} // namespace KAlarmCal
#endif // KALARM_REPETITION_H
// vim: et sw=4:
|