libkcal Library API Documentation

KCal::Attendee Class Reference

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

#include <attendee.h>

List of all members.

Public Types

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)
 Create Attendee.

virtual ~Attendee ()
 Destruct Attendee.

void setRole (Role)
 Set role of Attendee.

Role role () const
 Return role of Attendee.

QString roleStr () const
 Return role as clear text string.

QString uid ()
 Holds the uid of the attendee, if applicable *.

void setUid (QString)
void setStatus (PartStat s)
 Set status.

PartStat status () const
 Return status.

QString statusStr () const
 Return status as human-readable string.

void setRSVP (bool r)
 Set if Attendee is asked to reply.

bool RSVP () const
 Return, if Attendee is asked to reply.


Static Public Member Functions

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


Detailed Description

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

Definition at line 33 of file attendee.h.


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

Definition at line 30 of file attendee.cpp.

Attendee::~Attendee  )  [virtual]
 

Destruct Attendee.

Definition at line 41 of file attendee.cpp.


Member Function Documentation

void Attendee::setRole Role   ) 
 

Set role of Attendee.

List of roles still has to be documented.

Definition at line 104 of file attendee.cpp.

Attendee::Role Attendee::role  )  const
 

Return role of Attendee.

Definition at line 109 of file attendee.cpp.

QString Attendee::roleStr  )  const
 

Return role as clear text string.

Definition at line 114 of file attendee.cpp.

QString Attendee::uid  ) 
 

Holds the uid of the attendee, if applicable *.

Definition at line 124 of file attendee.cpp.

void Attendee::setStatus PartStat  s  ) 
 

Set status.

See enum for definitions of possible values

Definition at line 46 of file attendee.cpp.

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

Attendee::PartStat Attendee::status  )  const
 

Return status.

Definition at line 51 of file attendee.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

QString Attendee::statusStr  )  const
 

Return status as human-readable string.

Definition at line 56 of file attendee.cpp.

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

Set if Attendee is asked to reply.

Definition at line 78 of file attendee.h.

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

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

Return, if Attendee is asked to reply.

Definition at line 80 of file attendee.h.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:28 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001