KCalCore::FreeBusyPeriod Class Reference

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

#include <freebusyperiod.h>

Inheritance diagram for KCalCore::FreeBusyPeriod:

List of all members.

Public Types
typedef QVector< FreeBusyPeriod >	List
Public Member Functions
	FreeBusyPeriod ()
	FreeBusyPeriod (const KDateTime &start, const KDateTime &end)
	FreeBusyPeriod (const FreeBusyPeriod &period)
	FreeBusyPeriod (const Period &period)
	FreeBusyPeriod (const KDateTime &start, const Duration &duration)
	~FreeBusyPeriod ()
QString	location () const
FreeBusyPeriod &	operator= (const FreeBusyPeriod &other)
void	setLocation (const QString &location)
void	setSummary (const QString &summary)
QString	summary () const
Friends
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::FreeBusyPeriod &period)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::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 46 of file freebusyperiod.h.

---

Member Typedef Documentation

typedef QVector<FreeBusyPeriod> KCalCore::FreeBusyPeriod::List

List of periods.

Reimplemented from KCalCore::Period.

Definition at line 52 of file freebusyperiod.h.

---

Constructor & Destructor Documentation

FreeBusyPeriod::FreeBusyPeriod

(

)

Constructs a period without a duration.

Definition at line 48 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod	(	const KDateTime &	start,
		const KDateTime &	end
	)

Constructs a period from start to end.

Parameters:

start	the time the period begins.
end	the time the period ends.

Definition at line 52 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod	(	const KDateTime &	start,
		const Duration &	duration
	)

Constructs a period from start and lasting duration.

Parameters:

start	the time when the period starts.
duration	how long the period lasts.

Definition at line 57 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod

(

const FreeBusyPeriod &

period

)

Constructs a period by copying another period object.

Parameters:

period

the period to copy

Definition at line 62 of file freebusyperiod.cpp.

FreeBusyPeriod::FreeBusyPeriod

(

const Period &

period

)

Constructs a period by copying another period object.

Parameters:

period

the period to copy

Definition at line 67 of file freebusyperiod.cpp.

FreeBusyPeriod::~FreeBusyPeriod

(

)

Destroys a period.

Definition at line 72 of file freebusyperiod.cpp.

---

Member Function Documentation

QString FreeBusyPeriod::location

(

)

const

Returns the period location.

See also:

setLocation()

Definition at line 99 of file freebusyperiod.cpp.

FreeBusyPeriod & FreeBusyPeriod::operator=

(

const FreeBusyPeriod &

other

)

Sets this period equal to the other one.

Parameters:

other

is the other period to compare.

Definition at line 77 of file freebusyperiod.cpp.

void FreeBusyPeriod::setLocation

(

const QString &

location

)

Sets the period location.

Parameters:

location

is the period location string.

See also:

location().

Definition at line 104 of file freebusyperiod.cpp.

void FreeBusyPeriod::setSummary

(

const QString &

summary

)

Sets the period summary.

Parameters:

summary

is the period summary string.

See also:

summary().

Definition at line 94 of file freebusyperiod.cpp.

QString FreeBusyPeriod::summary

(

)

const

Returns the period summary.

See also:

setSummary()

Definition at line 89 of file freebusyperiod.cpp.

---

Friends And Related Function Documentation

KCALCORE_EXPORT QDataStream& operator<<	(	QDataStream &	stream,
		const KCalCore::FreeBusyPeriod &	period
	)		[friend]

Write period to the datastream stream, in binary format.

KCALCORE_EXPORT QDataStream& operator>>	(	QDataStream &	stream,
		KCalCore::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:

• freebusyperiod.h
• freebusyperiod.cpp