KCalendarCore::Attendee
#include <attendee.h>
Public Types | |
enum | CuType { Individual, Group, Resource, Room, Unknown } |
typedef QVector< 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 QString &name, const QString &email, bool rsvp=false, PartStat status=None, Role role=ReqParticipant, const QString &uid=QString()) | |
Attendee (const Attendee &attendee) | |
~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 (CuType cuType) |
void | setCuType (const QString &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 |
Friends | |
KCALENDARCORE_EXPORT QDataStream & | operator<< (QDataStream &s, const KCalendarCore::Attendee &attendee) |
KCALENDARCORE_EXPORT QDataStream & | operator>> (QDataStream &s, KCalendarCore::Attendee &attendee) |
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 45 of file attendee.h.
Member Typedef Documentation
typedef QVector<Attendee> KCalendarCore::Attendee::List |
List of attendees.
Definition at line 110 of file attendee.h.
Member Enumeration Documentation
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. Parameters that have to set via the QString variant of () and () x-name ; Experimental cuType iana-token ; Other IANA-registered |
Definition at line 93 of file attendee.h.
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 65 of file attendee.h.
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 80 of file attendee.h.
Constructor & Destructor Documentation
Attendee::Attendee | ( | ) |
Create a null Attendee.
Definition at line 108 of file attendee.cpp.
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 113 of file attendee.cpp.
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.
|
default |
Destroys the attendee.
Member Function Documentation
CustomProperties & Attendee::customProperties | ( | ) |
Returns a reference to the CustomProperties object.
Definition at line 299 of file attendee.cpp.
const CustomProperties & Attendee::customProperties | ( | ) | const |
Returns a const reference to the CustomProperties object.
Definition at line 304 of file attendee.cpp.
CuType KCalendarCore::Attendee::cuType | ( | ) | const |
QString Attendee::cuTypeStr | ( | ) | const |
Returns the CuType of the attendee.
- See also
- setCuType()
- Since
- 4.14
Definition at line 237 of file attendee.cpp.
QString KCalendarCore::Attendee::delegate | ( | ) | const |
Returns the delegate.
- See also
- setDelegate().
QString KCalendarCore::Attendee::delegator | ( | ) | const |
Returns the delegator.
- See also
- setDelegator().
QString KCalendarCore::Attendee::email | ( | ) | const |
Returns the email address for this attendee.
QString KCalendarCore::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 \<[email protected]\>".
bool KCalendarCore::Attendee::isNull | ( | ) | const |
Returns true
if this is a default-constructed Attendee instance.
QString KCalendarCore::Attendee::name | ( | ) | const |
Returns the name of the attendee.
bool KCalendarCore::Attendee::operator!= | ( | const Attendee & | attendee | ) | const |
Compares this with attendee
for inequality.
- Parameters
-
attendee the attendee to compare.
Definition at line 153 of file attendee.cpp.
Sets this attendee equal to attendee
.
- Parameters
-
attendee is the attendee to copy.
Definition at line 158 of file attendee.cpp.
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.
bool Attendee::RSVP | ( | ) | const |
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 294 of file attendee.cpp.
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 222 of file attendee.cpp.
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 227 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 274 of file attendee.cpp.
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 284 of file attendee.cpp.
void Attendee::setEmail | ( | const QString & | ) |
Sets the email address for this attendee to email
.
Definition at line 193 of file attendee.cpp.
void Attendee::setName | ( | const QString & | name | ) |
Sets the name of the attendee to name
.
Definition at line 174 of file attendee.cpp.
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 242 of file attendee.cpp.
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 202 of file attendee.cpp.
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 212 of file attendee.cpp.
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 252 of file attendee.cpp.
PartStat KCalendarCore::Attendee::status | ( | ) | const |
Returns the PartStat of the attendee.
- See also
- setStatus()
Friends And Related Function Documentation
|
friend |
Serializes an Attendee object into a data stream.
- Parameters
-
stream is a QDataStream. attendee is a pointer to a Attendee object to be serialized.
|
friend |
Initializes an Attendee object from a data stream.
- Parameters
-
stream is a QDataStream. attendee is a pointer to a Attendee object to be initialized.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Jan 16 2021 22:52:48 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.