KCalendarCore::Duration Class

Member Function Documentation

Duration::Duration()

Constructs a duration of 0 seconds.

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

Constructs a duration from start to end.

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.

start is the time the duration begins.

end is the time the duration ends.

Duration::Duration(int duration, KCalendarCore::Duration::Type type = Seconds)

Constructs a duration with a number of seconds or days.

duration the number of seconds or days in the duration

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

Duration::Duration(const QDateTime &start, const QDateTime &end, KCalendarCore::Duration::Type type)

Constructs a duration from start to end.

If type is Days, and the time of day in start's time zone differs between start and end, the duration will be rounded down to the nearest whole number of days.

start is the time the duration begins.

end is the time the duration ends.

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

Duration::Duration(const KCalendarCore::Duration &duration)

Constructs a duration by copying another duration object.

duration is the duration to copy.

[noexcept] Duration::~Duration()

Destroys a duration.

int Duration::asDays() const

Returns the length of the duration in days. If the duration is not an exact number of days, it is rounded down to return the number of whole days.

int Duration::asSeconds() const

Returns the length of the duration in seconds.

QDateTime Duration::end(const QDateTime &start) const

Computes a duration end time by adding the number of seconds or days in the duration to the specified start time.

start is the start time.

Returns end time.

bool Duration::isDaily() const

Returns whether the duration is specified in terms of days rather than seconds.

bool Duration::isNull() const

Returns true if the duration is 0 seconds.

KCalendarCore::Duration::Type Duration::type() const

Returns the time units (seconds or days) used to specify the duration.

int Duration::value() const

Returns the length of the duration in seconds or days.

Returns if isDaily(), duration in days, else duration in seconds

bool Duration::operator bool() const

Returns true if this duration is non-zero.

bool Duration::operator!() const

Returns true if this duration is zero.

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

Returns true if this duration is not equal to the other. Daily and non-daily durations are always considered unequal, since a day's duration may differ from 24 hours if it happens to span a daylight saving time change.

other is the other duration to compare.

KCalendarCore::Duration Duration::operator*(int value) const

Multiplies a duration by a value.

value value to multiply by

Returns resultant duration

KCalendarCore::Duration &Duration::operator*=(int value)

Multiplies this duration by a value.

value value to multiply by

KCalendarCore::Duration Duration::operator+(const KCalendarCore::Duration &other) const

Adds two durations. If one is in terms of days and the other in terms of seconds, the result is in terms of seconds.

other the other duration to add

Returns combined duration

KCalendarCore::Duration &Duration::operator+=(const KCalendarCore::Duration &other)

Adds another duration to this one. If one is in terms of days and the other in terms of seconds, the result is in terms of seconds. other the other duration to add

KCalendarCore::Duration Duration::operator-() const

Returns the negative of this duration.

KCalendarCore::Duration Duration::operator-(const KCalendarCore::Duration &other) const

Returns the difference between another duration and this. If one is in terms of days and the other in terms of seconds, the result is in terms of seconds.

other the other duration to subtract

Returns difference in durations

KCalendarCore::Duration &Duration::operator-=(const KCalendarCore::Duration &other)

Subtracts another duration from this one. If one is in terms of days and the other in terms of seconds, the result is in terms of seconds.

other the other duration to subtract

KCalendarCore::Duration Duration::operator/(int value) const

Divides a duration by a value.

value value to divide by

Returns resultant duration

KCalendarCore::Duration &Duration::operator/=(int value)

Divides this duration by a value.

value value to divide by

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

Returns true if this duration is smaller than the other.

other is the other duration to compare.

bool Duration::operator<=(const KCalendarCore::Duration &other) const

Returns true if this duration is smaller than or equal to the other.

other is the other duration to compare.

KCalendarCore::Duration &Duration::operator=(const KCalendarCore::Duration &duration)

Sets this duration equal to duration.

duration is the duration to copy.

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

Returns true if this duration is equal to the other. Daily and non-daily durations are always considered unequal, since a day's duration may differ from 24 hours if it happens to span a daylight saving time change.

other the other duration to compare

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

Returns true if this duration is greater than the other.

other is the other duration to compare.

bool Duration::operator>=(const KCalendarCore::Duration &other) const

Returns true if this duration is greater than or equal to the other.

other is the other duration to compare.