libkcal Library API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files
KCal::Attendee

KCal::Attendee Class Reference

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

#include <attendee.h>

Inheritance diagram for KCal::Attendee:

Inheritance graph
[legend]
Collaboration diagram for KCal::Attendee:

Collaboration graph
[legend]
List of all members.

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 ()

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

Member Function Documentation

void Attendee::setRole (  Role   ) 
 

Set role of Attendee.

Definition at line 111 of file attendee.cpp.

Attendee::Role Attendee::role (   )  const
 

Return role of Attendee.

Definition at line 116 of file attendee.cpp.

QString Attendee::roleStr (   )  const
 

Return role as clear text string.

Definition at line 121 of file attendee.cpp.

References roleName().

QString Attendee::roleName (  Role   )  [static]
 

Return string represenation of role.

Definition at line 136 of file attendee.cpp.

Referenced by roleList(), and roleStr().

QStringList Attendee::roleList (   )  [static]
 

Return string representations of all available roles.

Definition at line 155 of file attendee.cpp.

References roleName().

QString Attendee::uid (   )  const
 

Return unique id of the attendee.

Definition at line 131 of file attendee.cpp.

void Attendee::setUid (  const QString &   ) 
 

Set unique id of attendee.

Definition at line 126 of file attendee.cpp.

void Attendee::setStatus (  PartStat  s  ) 
 

Set status.

See enum for definitions of possible values.

Definition at line 53 of file attendee.cpp.

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

Attendee::PartStat Attendee::status (   )  const
 

Return status.

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

References statusName().

QString Attendee::statusName (  PartStat   )  [static]
 

Return string representation of attendee status.

Definition at line 68 of file attendee.cpp.

Referenced by statusList(), and statusStr().

QStringList Attendee::statusList (   )  [static]
 

Return string representations of all available attendee status values.

Definition at line 96 of file attendee.cpp.

References statusName().

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

Set if Attendee is asked to reply.

Definition at line 121 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 125 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.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 4 06:41:14 2005 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003