libkcal

KCal::Attendee Class Reference

This class represents information related to an attendee of an event. More...

#include <attendee.h>

Inheritance diagram for KCal::Attendee:

List of all members.


Public Types

typedef ListBase< AttendeeList
enum  PartStat {
  NeedsAction, Accepted, Declined, Tentative,
  Delegated, Completed, InProcess
}
enum  Role { ReqParticipant, OptParticipant, NonParticipant, Chair }

Public Member Functions

 Attendee (const QString &name, const QString &email, bool rsvp=false, PartStat status=NeedsAction, Role role=ReqParticipant, const QString &u=QString::null)
QString delegate () const
QString delegator () const
Role role () const
QString roleStr () const
bool RSVP () const
void setDelegate (const QString &delegate)
void setDelegator (const QString &delegator)
void setRole (Role)
void setRSVP (bool r)
void setStatus (PartStat s)
void setUid (const QString &)
PartStat status () const
QString statusStr () const
QString uid () const
virtual ~Attendee ()

Static Public Member Functions

static QStringList roleList ()
static QString roleName (Role)
static QStringList statusList ()
static QString statusName (PartStat)

Detailed Description

This class represents information related to an attendee of an event.

Definition at line 36 of file attendee.h.


Member Typedef Documentation

Definition at line 43 of file attendee.h.


Member Enumeration Documentation

Enumerator:
NeedsAction 
Accepted 
Declined 
Tentative 
Delegated 
Completed 
InProcess 

Definition at line 39 of file attendee.h.

Enumerator:
ReqParticipant 
OptParticipant 
NonParticipant 
Chair 

Definition at line 41 of file attendee.h.


Constructor & Destructor Documentation

Attendee::Attendee ( const QString name,
const QString email,
bool  rsvp = false,
Attendee::PartStat  s = NeedsAction,
Attendee::Role  r = ReqParticipant,
const QString u = QString::null 
)

Create Attendee.

Parameters:
name Name
email Email address
rsvp Request for reply
status Status (see enum for list)
role Role
u the uid for the attendee

Definition at line 31 of file attendee.cpp.

Attendee::~Attendee (  )  [virtual]

Destruct Attendee.

Definition at line 41 of file attendee.cpp.


Member Function Documentation

QString KCal::Attendee::delegate (  )  const [inline]

Returns the delegate.

Definition at line 135 of file attendee.h.

QString KCal::Attendee::delegator (  )  const [inline]

Returns the delegator.

Definition at line 144 of file attendee.h.

Attendee::Role Attendee::role (  )  const

Return role of Attendee.

Definition at line 119 of file attendee.cpp.

QStringList Attendee::roleList (  )  [static]

Return string representations of all available roles.

Definition at line 158 of file attendee.cpp.

QString Attendee::roleName ( Attendee::Role  r  )  [static]

Return string represenation of role.

Definition at line 139 of file attendee.cpp.

QString Attendee::roleStr (  )  const

Return role as clear text string.

Definition at line 124 of file attendee.cpp.

bool KCal::Attendee::RSVP (  )  const [inline]

Return, if Attendee is asked to reply.

Definition at line 126 of file attendee.h.

void KCal::Attendee::setDelegate ( const QString delegate  )  [inline]

Sets the delegate.

Definition at line 131 of file attendee.h.

void KCal::Attendee::setDelegator ( const QString delegator  )  [inline]

Sets the delegator.

Definition at line 140 of file attendee.h.

void Attendee::setRole ( Attendee::Role  r  ) 

Set role of Attendee.

Definition at line 114 of file attendee.cpp.

void KCal::Attendee::setRSVP ( bool  r  )  [inline]

Set if Attendee is asked to reply.

Definition at line 122 of file attendee.h.

void Attendee::setStatus ( Attendee::PartStat  s  ) 

Set status.

See enum for definitions of possible values.

Definition at line 56 of file attendee.cpp.

void Attendee::setUid ( const QString uid  ) 

Set unique id of attendee.

Definition at line 129 of file attendee.cpp.

Attendee::PartStat Attendee::status (  )  const

Return status.

Definition at line 61 of file attendee.cpp.

QStringList Attendee::statusList (  )  [static]

Return string representations of all available attendee status values.

Definition at line 99 of file attendee.cpp.

QString Attendee::statusName ( Attendee::PartStat  s  )  [static]

Return string representation of attendee status.

Definition at line 71 of file attendee.cpp.

QString Attendee::statusStr (  )  const

Return status as human-readable string.

Definition at line 66 of file attendee.cpp.

QString Attendee::uid (  )  const

Return unique id of the attendee.

Definition at line 134 of file attendee.cpp.


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