libkcal

KCal::Attendee

KCal::Attendee Class Reference

#include <attendee.h>

Inheritance diagram for KCal::Attendee:

KCal::Person List of all members.

Detailed Description

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

Definition at line 35 of file attendee.h.


Public Types

typedef ListBase< Attendee > List
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)
virtual ~Attendee ()
void setRole (Role)
Role role () const
QString roleStr () const
QString uid () const
void setUid (const QString &)
void setStatus (PartStat s)
PartStat status () const
QString statusStr () const
void setRSVP (bool r)
bool RSVP () const

Static Public Member Functions

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

Constructor & Destructor Documentation

Attendee::Attendee (  const QString &  name,
const QString &  email,
bool  rsvp = false,
PartStat  status = NeedsAction,
Role  role = 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

Attendee::Role Attendee::role (   )  const
 

Return role of Attendee.

Definition at line 117 of file attendee.cpp.

QStringList Attendee::roleList (   )  [static]
 

Return string representations of all available roles.

Definition at line 156 of file attendee.cpp.

QString Attendee::roleName (  Role   )  [static]
 

Return string represenation of role.

Definition at line 137 of file attendee.cpp.

QString Attendee::roleStr (   )  const
 

Return role as clear text string.

Definition at line 122 of file attendee.cpp.

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

Return, if Attendee is asked to reply.

Definition at line 125 of file attendee.h.

void Attendee::setRole (  Role   ) 
 

Set role of Attendee.

Definition at line 112 of file attendee.cpp.

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

Set if Attendee is asked to reply.

Definition at line 121 of file attendee.h.

void Attendee::setStatus (  PartStat  s  ) 
 

Set status.

See enum for definitions of possible values.

Definition at line 54 of file attendee.cpp.

void Attendee::setUid (  const QString &   ) 
 

Set unique id of attendee.

Definition at line 127 of file attendee.cpp.

Attendee::PartStat Attendee::status (   )  const
 

Return status.

Definition at line 59 of file attendee.cpp.

QStringList Attendee::statusList (   )  [static]
 

Return string representations of all available attendee status values.

Definition at line 97 of file attendee.cpp.

QString Attendee::statusName (  PartStat   )  [static]
 

Return string representation of attendee status.

Definition at line 69 of file attendee.cpp.

QString Attendee::statusStr (   )  const
 

Return status as human-readable string.

Definition at line 64 of file attendee.cpp.

QString Attendee::uid (   )  const
 

Return unique id of the attendee.

Definition at line 132 of file attendee.cpp.

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

libkcal

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys