KCalendarCore::Attendee
#include <attendee.h>
Public Types | |
enum | CuType { Individual , Group , Resource , Room , Unknown } |
typedef QList< Attendee > | List |
enum | PartStat { NeedsAction , Accepted , Declined , Tentative , Delegated , Completed , InProcess , None } |
enum | Role { ReqParticipant , OptParticipant , NonParticipant , Chair } |
Properties | |
CuType | cuType |
QString | delegate |
QString | delegator |
QString | |
QString | fullName |
bool | isNull |
QString | name |
Role | role |
bool | rsvp |
PartStat | status |
QString | uid |
Public Member Functions | |
Attendee () | |
Attendee (const Attendee &attendee) | |
Attendee (const QString &name, const QString &email, bool rsvp=false, PartStat status=None, Role role=ReqParticipant, const QString &uid=QString()) | |
~Attendee () | |
CustomProperties & | customProperties () |
const CustomProperties & | customProperties () const |
CuType | cuType () const |
QString | cuTypeStr () const |
QString | delegate () const |
QString | delegator () const |
QString | email () const |
QString | fullName () const |
bool | isNull () const |
QString | name () const |
bool | operator!= (const Attendee &attendee) const |
Attendee & | operator= (const Attendee &attendee) |
bool | operator== (const Attendee &attendee) const |
Role | role () const |
bool | RSVP () const |
void | setCustomProperty (const QByteArray &xname, const QString &xvalue) |
void | setCuType (const QString &cuType) |
void | setCuType (CuType cuType) |
void | setDelegate (const QString &delegate) |
void | setDelegator (const QString &delegator) |
void | setEmail (const QString &email) |
void | setName (const QString &name) |
void | setRole (Role role) |
void | setRSVP (bool rsvp) |
void | setStatus (PartStat status) |
void | setUid (const QString &uid) |
PartStat | status () const |
QString | uid () const |
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 44 of file attendee.h.
Member Typedef Documentation
◆ List
List of attendees.
Definition at line 109 of file attendee.h.
Member Enumeration Documentation
◆ CuType
The different types of a participant.
- Since
- 4.14
Enumerator | |
---|---|
Individual | An individual (default) |
Group | A group of individuals. |
Resource | A physical resource. |
Room | A room resource. |
Unknown | Otherwise not known. |
Definition at line 92 of file attendee.h.
◆ PartStat
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.
◆ 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 79 of file attendee.h.
Property Documentation
◆ cuType
|
readwrite |
Definition at line 54 of file attendee.h.
◆ delegate
|
readwrite |
Definition at line 56 of file attendee.h.
◆ delegator
|
readwrite |
Definition at line 57 of file attendee.h.
|
readwrite |
Definition at line 50 of file attendee.h.
◆ fullName
|
read |
Definition at line 49 of file attendee.h.
◆ isNull
|
read |
Definition at line 47 of file attendee.h.
◆ name
|
readwrite |
Definition at line 48 of file attendee.h.
◆ role
|
readwrite |
Definition at line 51 of file attendee.h.
◆ rsvp
|
readwrite |
Definition at line 55 of file attendee.h.
◆ status
|
readwrite |
Definition at line 53 of file attendee.h.
◆ uid
|
readwrite |
Definition at line 52 of file attendee.h.
Constructor & Destructor Documentation
◆ Attendee() [1/3]
Attendee::Attendee | ( | ) |
Create a null Attendee.
Definition at line 109 of file attendee.cpp.
◆ Attendee() [2/3]
Attendee::Attendee | ( | const QString & | name, |
const QString & | email, | ||
bool | rsvp = false, | ||
Attendee::PartStat | status = None, | ||
Attendee::Role | role = 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.
- 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 114 of file attendee.cpp.
◆ Attendee() [3/3]
Attendee::Attendee | ( | const Attendee & | attendee | ) |
Constructs an attendee by copying another attendee.
- Parameters
-
attendee is the attendee to be copied.
Definition at line 126 of file attendee.cpp.
◆ ~Attendee()
|
default |
Destroys the attendee.
Member Function Documentation
◆ customProperties() [1/2]
CustomProperties & Attendee::customProperties | ( | ) |
Returns a reference to the CustomProperties object.
Definition at line 292 of file attendee.cpp.
◆ customProperties() [2/2]
const CustomProperties & Attendee::customProperties | ( | ) | const |
Returns a const reference to the CustomProperties object.
Definition at line 297 of file attendee.cpp.
◆ cuType()
Attendee::CuType Attendee::cuType | ( | ) | const |
Returns the CuType of the attendee.
- See also
- setCuType()
- Since
- 4.14
Definition at line 225 of file attendee.cpp.
◆ cuTypeStr()
QString Attendee::cuTypeStr | ( | ) | const |
Returns the CuType of the attendee.
- See also
- setCuType()
- Since
- 4.14
Definition at line 230 of file attendee.cpp.
◆ delegate()
QString Attendee::delegate | ( | ) | const |
◆ delegator()
QString Attendee::delegator | ( | ) | const |
◆ email()
QString Attendee::email | ( | ) | const |
Returns the email address for this attendee.
Definition at line 181 of file attendee.cpp.
◆ fullName()
QString Attendee::fullName | ( | ) | const |
Returns the full name and email address of this attendee.
- Returns
- A QString containing the person's full name in the form "FirstName LastName \<mail@domain\>".
Definition at line 176 of file attendee.cpp.
◆ isNull()
bool Attendee::isNull | ( | ) | const |
Returns true
if this is a default-constructed Attendee instance.
Definition at line 133 of file attendee.cpp.
◆ name()
QString Attendee::name | ( | ) | const |
Returns the name of the attendee.
Definition at line 162 of file attendee.cpp.
◆ operator!=()
bool KCalendarCore::Attendee::operator!= | ( | const Attendee & | attendee | ) | const |
Compares this with attendee
for inequality.
- Parameters
-
attendee the attendee to compare.
Definition at line 146 of file attendee.cpp.
◆ operator=()
Sets this attendee equal to attendee
.
- Parameters
-
attendee is the attendee to copy.
Definition at line 151 of file attendee.cpp.
◆ operator==()
bool KCalendarCore::Attendee::operator== | ( | const Attendee & | attendee | ) | const |
Compares this with attendee
for equality.
- Parameters
-
attendee the attendee to compare.
Definition at line 139 of file attendee.cpp.
◆ role()
Attendee::Role Attendee::role | ( | ) | const |
◆ RSVP()
bool Attendee::RSVP | ( | ) | const |
◆ setCustomProperty()
void Attendee::setCustomProperty | ( | const QByteArray & | xname, |
const QString & | xvalue ) |
Adds a custom property.
If the property already exists it will be overwritten.
- Parameters
-
xname is the name of the property. xvalue is its value.
Definition at line 287 of file attendee.cpp.
◆ setCuType() [1/2]
void Attendee::setCuType | ( | const QString & | cuType | ) |
Sets the CuType of the attendee to cuType
.
- Parameters
-
cuType is the CuType to use for the attendee.
- See also
- cuType()
- Since
- 4.14
Definition at line 220 of file attendee.cpp.
◆ setCuType() [2/2]
void Attendee::setCuType | ( | Attendee::CuType | cuType | ) |
Sets the CuType of the attendee to cuType
.
- Parameters
-
cuType is the CuType to use for the attendee.
- See also
- cuType()
- Since
- 4.14
Definition at line 215 of file attendee.cpp.
◆ setDelegate()
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 267 of file attendee.cpp.
◆ setDelegator()
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 277 of file attendee.cpp.
◆ setEmail()
void Attendee::setEmail | ( | const QString & | ) |
Sets the email address for this attendee to email
.
Definition at line 186 of file attendee.cpp.
◆ setName()
void Attendee::setName | ( | const QString & | name | ) |
Sets the name of the attendee to name
.
Definition at line 167 of file attendee.cpp.
◆ setRole()
void Attendee::setRole | ( | Attendee::Role | role | ) |
Sets the Role of the attendee to role
.
- Parameters
-
role is the Role to use for the attendee.
- See also
- role()
Definition at line 235 of file attendee.cpp.
◆ setRSVP()
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 195 of file attendee.cpp.
◆ setStatus()
void Attendee::setStatus | ( | Attendee::PartStat | status | ) |
Sets the PartStat of the attendee to status
.
- Parameters
-
status is the PartStat to use for the attendee.
- See also
- status()
Definition at line 205 of file attendee.cpp.
◆ setUid()
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 245 of file attendee.cpp.
◆ status()
Attendee::PartStat Attendee::status | ( | ) | const |
Returns the PartStat of the attendee.
- See also
- setStatus()
Definition at line 210 of file attendee.cpp.
◆ uid()
QString Attendee::uid | ( | ) | const |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 12:00:28 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.