KCalendarCore::Period Class

Member Function Documentation

Period::Period()

Constructs a period without a duration.

Period::Period(const QDateTime &start, const KCalendarCore::Duration &duration)

Constructs a period from start and lasting duration.

start the time when the period starts.

duration how long the period lasts.

Period::Period(const QDateTime &start, const QDateTime &end)

Constructs a period from start to end.

start the time the period begins.

end the time the period ends.

Period::Period(const KCalendarCore::Period &period)

Constructs a period by copying another period object

period the period to copy

[noexcept] Period::~Period()

Destroys a period.

KCalendarCore::Duration Period::duration() 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 start() and 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.

KCalendarCore::Duration Period::duration(KCalendarCore::Duration::Type type) 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 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.

type the unit of time to use (seconds or days)

QDateTime Period::end() const

Returns when this period ends.

bool Period::hasDuration() const

Returns true if this period has a set duration, false if it just has a start and an end.

[since 5.87] bool Period::isValid() const

Returns true if the Period is not empty.

This function was introduced in 5.87.

void Period::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone)

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 (oldZone) of Europe/London, to a new time zone (newZone) 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.

oldZone the time zone which provides the clock times

newZone the new time zone

QDateTime Period::start() const

Returns when this period starts.

bool Period::operator!=(const KCalendarCore::Period &other) const

Returns true if this period is not equal to the other one.

other the other period to compare

See also operator==().

bool Period::operator<(const KCalendarCore::Period &other) const

Returns true if the start of this period is earlier than the start of the other one.

other is the other period to compare.

KCalendarCore::Period &Period::operator=(const KCalendarCore::Period &other)

Sets this period equal to the other one.

other is the other period to compare.

bool Period::operator==(const KCalendarCore::Period &other) const

Returns true if this period is equal to the 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.

other the other period to compare

bool Period::operator>(const KCalendarCore::Period &other) const

Returns true if the start of this period is later than the start of the other one.

other the other period to compare