KCalendarCore::FreeBusyPeriod

KCalendarCore::FreeBusyPeriod Class Reference

#include <freebusyperiod.h>

Inheritance diagram for KCalendarCore::FreeBusyPeriod:

Public Types

enum  FreeBusyType {
  Free, Busy, BusyUnavailable, BusyTentative,
  Unknown
}
 
typedef QVector< FreeBusyPeriodList
 
- Public Types inherited from KCalendarCore::Period
typedef QVector< PeriodList
 

Public Member Functions

 FreeBusyPeriod ()
 
 FreeBusyPeriod (const QDateTime &start, const QDateTime &end)
 
 FreeBusyPeriod (const QDateTime &start, const Duration &duration)
 
 FreeBusyPeriod (const FreeBusyPeriod &period)
 
 FreeBusyPeriod (const Period &period)
 
 ~FreeBusyPeriod ()
 
QString location () const
 
FreeBusyPeriodoperator= (const FreeBusyPeriod &other)
 
void setLocation (const QString &location)
 
void setSummary (const QString &summary)
 
void setType (FreeBusyType type)
 
QString summary () const
 
FreeBusyType type () const
 
- Public Member Functions inherited from KCalendarCore::Period
 Period ()
 
 Period (const QDateTime &start, const QDateTime &end)
 
 Period (const QDateTime &start, const Duration &duration)
 
 Period (const Period &period)
 
 ~Period ()
 
Duration duration () const
 
Duration duration (Duration::Type type) const
 
QDateTime end () const
 
bool hasDuration () const
 
bool operator!= (const Period &other) const
 
bool operator< (const Period &other) const
 
Periodoperator= (const Period &other)
 
bool operator== (const Period &other) const
 
bool operator> (const Period &other) const
 
void shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone)
 
QDateTime start () const
 

Friends

KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::FreeBusyPeriod &period)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::FreeBusyPeriod &period)
 

Detailed Description

The period can be defined by either a start time and an end time or by a start time and a duration.

Definition at line 34 of file freebusyperiod.h.

Member Typedef Documentation

List of periods.

Definition at line 48 of file freebusyperiod.h.

Constructor & Destructor Documentation

FreeBusyPeriod::FreeBusyPeriod ( )

Constructs a period without a duration.

Definition at line 38 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod ( const QDateTime start,
const QDateTime end 
)

Constructs a period from start to end.

Parameters
startthe time the period begins.
endthe time the period ends.

Definition at line 42 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod ( const QDateTime start,
const Duration duration 
)

Constructs a period from start and lasting duration.

Parameters
startthe time when the period starts.
durationhow long the period lasts.

Definition at line 47 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod ( const FreeBusyPeriod period)

Constructs a period by copying another period object.

Parameters
periodthe period to copy

Definition at line 52 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod ( const Period period)

Constructs a period by copying another period object.

Parameters
periodthe period to copy

Definition at line 57 of file freebusyperiod.cpp.

FreeBusyPeriod::~FreeBusyPeriod ( )

Destroys a period.

Definition at line 62 of file freebusyperiod.cpp.

Member Function Documentation

QString FreeBusyPeriod::location ( ) const

Returns the period location.

See also
setLocation()

Definition at line 89 of file freebusyperiod.cpp.

FreeBusyPeriod & FreeBusyPeriod::operator= ( const FreeBusyPeriod other)

Sets this period equal to the other one.

Parameters
otheris the other period to compare.

Definition at line 67 of file freebusyperiod.cpp.

void FreeBusyPeriod::setLocation ( const QString location)

Sets the period location.

Parameters
locationis the period location string.
See also
location().

Definition at line 94 of file freebusyperiod.cpp.

void FreeBusyPeriod::setSummary ( const QString summary)

Sets the period summary.

Parameters
summaryis the period summary string.
See also
summary().

Definition at line 84 of file freebusyperiod.cpp.

void FreeBusyPeriod::setType ( FreeBusyPeriod::FreeBusyType  type)

Sets the free/busy type.

Parameters
typeis the type of free/busy period
See also
type().
Since
5.0

Definition at line 104 of file freebusyperiod.cpp.

QString FreeBusyPeriod::summary ( ) const

Returns the period summary.

See also
setSummary()

Definition at line 79 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyType FreeBusyPeriod::type ( ) const

Returns free/busy type.

See also
setType().
Since
5.0

Definition at line 99 of file freebusyperiod.cpp.

Friends And Related Function Documentation

KCALENDARCORE_EXPORT QDataStream& operator<< ( QDataStream stream,
const KCalendarCore::FreeBusyPeriod period 
)
friend

Write period to the datastream stream, in binary format.

KCALENDARCORE_EXPORT QDataStream& operator>> ( QDataStream stream,
KCalendarCore::FreeBusyPeriod period 
)
friend

Read a Period object into period from stream, in binary format.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Aug 6 2020 22:50:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.