KCalCore::Attendee Class Reference

Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do). More...

#include <attendee.h>

Inheritance diagram for KCalCore::Attendee:

Public Types
typedef QVector< Ptr >	List
enum	PartStat { NeedsAction, Accepted, Declined, Tentative, Delegated, Completed, InProcess, None }
typedef QSharedPointer< Attendee >	Ptr
enum	Role { ReqParticipant, OptParticipant, NonParticipant, Chair }
Public Member Functions
	Attendee (const Attendee &attendee)
	Attendee (const QString &name, const QString &email, bool rsvp=false, PartStat status=None, Role role=ReqParticipant, const QString &uid=QString())
	~Attendee ()
const CustomProperties &	customProperties () const
CustomProperties &	customProperties ()
QString	delegate () const
QString	delegator () const
bool	operator!= (const Attendee &attendee) const
Attendee &	operator= (const Attendee &attendee)
bool	operator== (const Attendee &attendee) const
Role	role () const
bool	RSVP () const
void	setCustomProperty (const QByteArray &xname, const QString &xvalue)
void	setDelegate (const QString &delegate)
void	setDelegator (const QString &delegator)
void	setRole (Role role)
void	setRSVP (bool rsvp)
void	setStatus (PartStat status)
void	setUid (const QString &uid)
PartStat	status () const
QString	uid () const
Friends
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &s, const KCalCore::Attendee::Ptr &attendee)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &s, KCalCore::Attendee::Ptr &attendee)

Detailed Description

Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do).

Attendees are people with a name and (optional) email address who are invited to participate in some way in a meeting or task. This class also tracks that status of the invitation: accepted; tentatively accepted; declined; delegated to another person; in-progress; completed.

Attendees may optionally be asked to RSVP ("Respond Please") to the invitation.

Note that each attendee be can optionally associated with a UID (unique identifier) derived from a Calendar Incidence, Email Message, or any other thing you want.

Definition at line 57 of file attendee.h.

Member Typedef Documentation

typedef QVector<Ptr> KCalCore::Attendee::List

List of attendees.

Reimplemented from KCalCore::Person.

Definition at line 99 of file attendee.h.

typedef QSharedPointer<Attendee> KCalCore::Attendee::Ptr

A shared pointer to an Attendee object.

Reimplemented from KCalCore::Person.

Definition at line 94 of file attendee.h.

Member Enumeration Documentation

enum KCalCore::Attendee::PartStat

The different types of participant status.

The meaning is specific to the incidence type in context.

Enumerator:

NeedsAction	Event, to-do or journal needs action (default).
Accepted	Event, to-do or journal accepted.
Declined	Event, to-do or journal declined.
Tentative	Event or to-do tentatively accepted.
Delegated	Event or to-do delegated.
Completed	To-do completed.
InProcess	To-do in process of being completed.

Definition at line 70 of file attendee.h.

enum KCalCore::Attendee::Role

The different types of participation roles.

Enumerator:

ReqParticipant	Participation is required (default).
OptParticipant	Participation is optional.
NonParticipant	Non-Participant; copied for information purposes.
Chair	Chairperson.

Definition at line 84 of file attendee.h.

Constructor & Destructor Documentation

Attendee::Attendee	(	const QString &	name,
		const QString &	email,
		bool	rsvp = `false`,
		Attendee::PartStat	status = `None`,
		Attendee::Role	role = `ReqParticipant`,
		const QString &	uid = `QString()`
	)

Constructs an attendee consisting of a Person name (name) and email address (email); invitation status and Role; an optional RSVP flag and UID.

Private class that helps to provide binary compatibility between releases.

Parameters:

	name	is person name of the attendee.
	email	is person email address of the attendee.
	rsvp	if true, the attendee is requested to reply to invitations.
	status	is the PartStat status of the attendee.
	role	is the Role of the attendee.
	uid	is the UID of the attendee.

For internal use only.

Definition at line 55 of file attendee.cpp.

Attendee::Attendee ( const Attendee & attendee )

Constructs an attendee by copying another attendee.

Parameters:

attendee

is the attendee to be copied.

Definition at line 67 of file attendee.cpp.

Attendee::~Attendee ( )

Destroys the attendee.

Definition at line 73 of file attendee.cpp.

Member Function Documentation

const CustomProperties & Attendee::customProperties ( ) const

Returns a const reference to the CustomProperties object.

Definition at line 178 of file attendee.cpp.

CustomProperties & Attendee::customProperties ( )

Returns a reference to the CustomProperties object.

Definition at line 173 of file attendee.cpp.

QString Attendee::delegate ( ) const

Returns the delegate.

See also:: setDelegate().

Definition at line 153 of file attendee.cpp.

QString Attendee::delegator ( ) const

Returns the delegator.

See also:: setDelegator().

Definition at line 163 of file attendee.cpp.

bool KCalCore::Attendee::operator!= ( const Attendee & attendee ) const

Compares this with attendee for inequality.

Parameters:

attendee

the attendee to compare.

Reimplemented from KCalCore::Person.

Definition at line 90 of file attendee.cpp.

Attendee & KCalCore::Attendee::operator= ( const Attendee & attendee )

Sets this attendee equal to attendee.

Parameters:

attendee

is the attendee to copy.

Reimplemented from KCalCore::Person.

Definition at line 95 of file attendee.cpp.

bool KCalCore::Attendee::operator== ( const Attendee & attendee ) const

Compares this with attendee for equality.

Parameters:

attendee

the attendee to compare.

Reimplemented from KCalCore::Person.

Definition at line 78 of file attendee.cpp.

Attendee::Role Attendee::role ( ) const

Returns the Role of the attendee.

See also:: setRole()

Definition at line 133 of file attendee.cpp.

bool Attendee::RSVP ( ) const

Returns the attendee RSVP flag.

See also:: setRSVP()

Definition at line 113 of file attendee.cpp.

void Attendee::setCustomProperty	(	const QByteArray &	xname,
		const QString &	xvalue
	)

Adds a custom property.

If the property already exists it will be overwritten.

Parameters:

	xname	is the name of the property.
	xvalue	is its value.

Definition at line 168 of file attendee.cpp.

void Attendee::setDelegate ( const QString & delegate )

Sets the delegate.

Parameters:

delegate

is a string containing a MAILTO URI of those delegated to attend the meeting.

See also:: delegate(), setDelegator().

Definition at line 148 of file attendee.cpp.

void Attendee::setDelegator ( const QString & delegator )

Sets the delegator.

Parameters:

delegator

is a string containing a MAILTO URI of those who have delegated their meeting attendance.

See also:: delegator(), setDelegate().

Definition at line 158 of file attendee.cpp.

void Attendee::setRole ( Attendee::Role role )

Sets the Role of the attendee to role.

Parameters:

role

is the Role to use for the attendee.

See also:: role()

Definition at line 128 of file attendee.cpp.

void Attendee::setRSVP ( bool rsvp )

Sets the RSVP flag of the attendee to rsvp.

Parameters:

rsvp

if set (true), the attendee is requested to reply to invitations.

See also:: RSVP()

Definition at line 108 of file attendee.cpp.

void Attendee::setStatus ( Attendee::PartStat status )

Sets the PartStat of the attendee to status.

Parameters:

status

is the PartStat to use for the attendee.

See also:: status()

Definition at line 118 of file attendee.cpp.

void Attendee::setUid ( const QString & uid )

Sets the UID of the attendee to uid.

Parameters:

uid

is the UID to use for the attendee.

See also:: uid()

Definition at line 138 of file attendee.cpp.

Attendee::PartStat Attendee::status ( ) const

Returns the PartStat of the attendee.

See also:: setStatus()

Definition at line 123 of file attendee.cpp.

QString Attendee::uid ( ) const

Returns the UID of the attendee.

See also:: setUid()

Definition at line 143 of file attendee.cpp.

Friends And Related Function Documentation

KCALCORE_EXPORT QDataStream& operator<<	(	QDataStream &	s,
		const KCalCore::Attendee::Ptr &	attendee
	)			`[friend]`

Serializes an Attendee object into a data stream.

Parameters:

	stream	is a QDataStream.
	attendee	is a pointer to a Attendee object to be serialized.

KCALCORE_EXPORT QDataStream& operator>>	(	QDataStream &	s,
		KCalCore::Attendee::Ptr &	attendee
	)			`[friend]`

Initializes an Attendee object from a data stream.

Parameters:

	stream	is a QDataStream.
	attendee	is a pointer to a Attendee object to be initialized.

The documentation for this class was generated from the following files:

KCalCore Library

KCalCore::Attendee Class Reference

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

KCalCore Library

KDE-PIM Libraries