KCal Library
KCal::Attendee Class Reference
#include <attendee.h>

Detailed Description
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do).Attendees are people with a name and (optional) email address who are invited to participate in some way in a meeting or task. This class also tracks that status of the invitation: accepted; tentatively accepted; declined; delegated to another person; in-progress; completed.
Attendees may optionally be asked to RSVP ("Respond Please") to the invitation.
Note that each attendee be can optionally associated with a UID (unique identifier) derived from a Calendar Incidence, Email Message, or any other thing you want.
Definition at line 56 of file attendee.h.
Public Types | |
enum | PartStat { NeedsAction, Accepted, Declined, Tentative, Delegated, Completed, InProcess } |
enum | Role { ReqParticipant, OptParticipant, NonParticipant, Chair } |
typedef ListBase< Attendee > | List |
Public Member Functions | |
Attendee (const QString &name, const QString &email, bool rsvp=false, PartStat status=NeedsAction, Role role=ReqParticipant, const QString &uid=QString()) | |
virtual | ~Attendee () |
void | setRole (Role role) |
Role | role () const |
QString | roleStr () const |
void | setUid (const QString &uid) |
QString | uid () const |
void | setStatus (PartStat status) |
PartStat | status () const |
QString | statusStr () const |
void | setRSVP (bool rsvp) |
bool | RSVP () const |
bool | operator== (const Attendee &attendee) |
void | setDelegate (const QString &delegate) |
QString | delegate () const |
void | setDelegator (const QString &delegator) |
QString | delegator () const |
Static Public Member Functions | |
static QString | roleName (Role role) |
static QStringList | roleList () |
static QString | statusName (PartStat status) |
static QStringList | statusList () |
Member Typedef Documentation
typedef ListBase<Attendee> KCal::Attendee::List |
Member Enumeration Documentation
The different types of participant status.
The meaning is specific to the incidence type in context.
- Enumerator:
-
NeedsAction Event, to-do or journal needs action (default). Accepted Event, to-do or journal accepted. Declined Event, to-do or journal declined. Tentative Event or to-do tentatively accepted. Delegated Event or to-do delegated. Completed To-do completed. InProcess To-do in process of being completed.
Definition at line 64 of file attendee.h.
enum KCal::Attendee::Role |
The different types of participation roles.
- Enumerator:
-
ReqParticipant Participation is required (default). OptParticipant Participation is optional. NonParticipant Non-Participant; copied for information purposes. Chair Chairperson.
Definition at line 77 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 & | uid = QString() | |||
) |
Constructs an attendee consisting of a Person name (name
) and email address (email
); invitation status and Role; an optional RSVP flag and UID.
Private class that helps to provide binary compatibility between releases.
- Parameters:
-
name is person name of the attendee. email is person email address of the attendee. rsvp if true, the attendee is requested to reply to invitations. status is the PartStat status of the attendee. role is the Role of the attendee. uid is the UID of the attendee.
Definition at line 58 of file attendee.cpp.
Attendee::~Attendee | ( | ) | [virtual] |
Member Function Documentation
void Attendee::setRole | ( | Attendee::Role | r | ) |
Sets the Role of the attendee to role
.
- Parameters:
-
role is the Role to use for the attendee.
- See also:
- role()
Definition at line 154 of file attendee.cpp.
Attendee::Role Attendee::role | ( | ) | const |
QString Attendee::roleStr | ( | ) | const |
Returns the attendee Role as a text string.
- See also:
- role(), roleName()
Definition at line 164 of file attendee.cpp.
QString Attendee::roleName | ( | Attendee::Role | role | ) | [static] |
QStringList Attendee::roleList | ( | ) | [static] |
void Attendee::setUid | ( | const QString & | uid | ) |
Sets the UID of the attendee to uid
.
- Parameters:
-
uid is the UID to use for the attendee.
- See also:
- uid()
Definition at line 169 of file attendee.cpp.
QString Attendee::uid | ( | ) | const |
void Attendee::setStatus | ( | Attendee::PartStat | s | ) |
Sets the PartStat of the attendee to status
.
- Parameters:
-
status is the PartStat to use for the attendee.
- See also:
- status()
Definition at line 97 of file attendee.cpp.
Attendee::PartStat Attendee::status | ( | ) | const |
Returns the PartStat of the attendee.
- See also:
- setStatus()
Definition at line 102 of file attendee.cpp.
QString Attendee::statusStr | ( | ) | const |
Returns the attendee PartStat as a text string.
- See also:
- status(), statusName()
Definition at line 107 of file attendee.cpp.
QString Attendee::statusName | ( | Attendee::PartStat | status | ) | [static] |
Returns the specified PartStat status
as a text string.
- Parameters:
-
status is a PartStat value.
- See also:
- status(), statusStr()
Definition at line 112 of file attendee.cpp.
QStringList Attendee::statusList | ( | ) | [static] |
void Attendee::setRSVP | ( | bool | rsvp | ) |
Sets the RSVP flag of the attendee to rsvp
.
- Parameters:
-
rsvp if set (true), the attendee is requested to reply to invitations.
- See also:
- RSVP()
Definition at line 87 of file attendee.cpp.
bool Attendee::RSVP | ( | ) | const |
bool KCal::Attendee::operator== | ( | const Attendee & | attendee | ) |
Compares this with attendee
for equality.
- Parameters:
-
attendee the attendee to compare.
Definition at line 75 of file attendee.cpp.
void Attendee::setDelegate | ( | const QString & | delegate | ) |
Sets the delegate.
- Parameters:
-
delegate is a string containing a MAILTO URI of those delegated to attend the meeting.
- See also:
- delegate(), setDelegator().
Definition at line 209 of file attendee.cpp.
QString Attendee::delegate | ( | ) | const |
void Attendee::setDelegator | ( | const QString & | delegator | ) |
Sets the delegator.
- Parameters:
-
delegator is a string containing a MAILTO URI of those who have delegated their meeting attendance.
- See also:
- delegator(), setDelegate().
Definition at line 219 of file attendee.cpp.
QString Attendee::delegator | ( | ) | const |
The documentation for this class was generated from the following files: