• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • Attendee
Public Types | Public Member Functions | Friends | List of all members
KCalCore::Attendee Class Reference

#include <attendee.h>

Inheritance diagram for KCalCore::Attendee:
KCalCore::Person

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 QString &name, const QString &email, bool rsvp=false, PartStat status=None, Role role=ReqParticipant, const QString &uid=QString())
 
 Attendee (const Attendee &attendee)
 
 ~Attendee ()
 
CustomProperties & customProperties ()
 
const CustomProperties & customProperties () const
 
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)
 

Additional Inherited Members

- Private Types inherited from KCalCore::Person
typedef QVector< Ptr > List
 
typedef QSharedPointer< Person > Ptr
 
- Private Member Functions inherited from KCalCore::Person
 Person ()
 
 Person (const QString &name, const QString &email)
 
 Person (const Person &person)
 
virtual ~Person ()
 
int count () const
 
QString email () const
 
QString fullName () const
 
bool isEmpty () const
 
QString name () const
 
bool operator!= (const Person &person) const
 
Person & operator= (const Person &person)
 
bool operator== (const Person &person) const
 
void setCount (int count)
 
void setEmail (const QString &email)
 
void setName (const QString &name)
 
- Static Private Member Functions inherited from KCalCore::Person
static Person::Ptr fromFullName (const QString &fullName)
 
static bool isValidEmail (const QString &email)
 

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.

Definition at line 99 of file attendee.h.

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

A shared pointer to an Attendee object.

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
nameis person name of the attendee.
emailis person email address of the attendee.
rsvpif true, the attendee is requested to reply to invitations.
statusis the PartStat status of the attendee.
roleis the Role of the attendee.
uidis the UID of the attendee.

Definition at line 55 of file attendee.cpp.

Attendee::Attendee ( const Attendee &  attendee)

Constructs an attendee by copying another attendee.

Parameters
attendeeis 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

CustomProperties & Attendee::customProperties ( )

Returns a reference to the CustomProperties object.

Definition at line 173 of file attendee.cpp.

const CustomProperties & Attendee::customProperties ( ) const

Returns a const reference to the CustomProperties object.

Definition at line 178 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
attendeethe attendee to compare.

Definition at line 90 of file attendee.cpp.

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

Sets this attendee equal to attendee.

Parameters
attendeeis the attendee to copy.

Definition at line 95 of file attendee.cpp.

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

Compares this with attendee for equality.

Parameters
attendeethe attendee to compare.

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
xnameis the name of the property.
xvalueis its value.

Definition at line 168 of file attendee.cpp.

void Attendee::setDelegate ( const QString &  delegate)

Sets the delegate.

Parameters
delegateis 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
delegatoris 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
roleis 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
rsvpif 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
statusis 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
uidis 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
streamis a QDataStream.
attendeeis 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
streamis a QDataStream.
attendeeis a pointer to a Attendee object to be initialized.

The documentation for this class was generated from the following files:
  • attendee.h
  • attendee.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:24:53 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal