libkcal Library API Documentation

KCal::Attendee Class Reference

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

#include <attendee.h>

Inheritance diagram for KCal::Attendee:

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

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 35 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
u the uid for the attendee

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 115 of file attendee.cpp.

Attendee::Role Attendee::role  )  const
 

Return role of Attendee.

Definition at line 120 of file attendee.cpp.

QString Attendee::roleStr  )  const
 

Return role as clear text string.

Definition at line 125 of file attendee.cpp.

QString Attendee::uid  )  const
 

Holds the uid of the attendee, if applicable *.

Definition at line 135 of file attendee.cpp.

void Attendee::setStatus PartStat  s  ) 
 

Set status.

See enum for definitions of possible values

Definition at line 57 of file attendee.cpp.

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

Attendee::PartStat Attendee::status  )  const
 

Return status.

Definition at line 62 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 67 of file attendee.cpp.

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

Set if Attendee is asked to reply.

Definition at line 83 of file attendee.h.

References setRSVP().

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

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

Return, if Attendee is asked to reply.

Definition at line 85 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 libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 28 23:57:45 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003