• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • kcal
attendee.h
Go to the documentation of this file.
1/*
2 This file is part of the kcal library.
3
4 Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
28
29#ifndef KCAL_ATTENDEE_H
30#define KCAL_ATTENDEE_H
31
32#include <QtCore/QString>
33#include <QtCore/QStringList>
34
35#include "listbase.h"
36#include "person.h"
37#include "customproperties.h"
38
39namespace KCal {
40
58class KCAL_DEPRECATED_EXPORT Attendee : private Person
59{
60 public:
61 using Person::setEmail;
62 using Person::email;
63 using Person::setName;
64 using Person::name;
65 using Person::fullName;
66
71 enum PartStat {
72 NeedsAction,
73 Accepted,
74 Declined,
75 Tentative,
76 Delegated,
77 Completed,
78 InProcess,
79 None
80 };
81
85 enum Role {
86 ReqParticipant,
87 OptParticipant,
88 NonParticipant,
89 Chair
90 };
91
95 typedef ListBase<Attendee> List;
96
109 Attendee( const QString &name, const QString &email,
110 bool rsvp = false, PartStat status = None,
111 Role role = ReqParticipant, const QString &uid = QString() );
112
118 Attendee( const Attendee &attendee );
119
123 ~Attendee();
124
132 void setRole( Role role );
133
139 Role role() const;
140
146 QString roleStr() const;
147
155 static QString roleName( Role role );
156
160 static QStringList roleList();
161
169 void setUid ( const QString &uid );
170
176 QString uid() const;
177
185 void setStatus( PartStat status );
186
192 PartStat status() const;
193
199 QString statusStr() const;
200
208 static QString statusName( PartStat status );
209
213 static QStringList statusList();
214
223 void setRSVP( bool rsvp );
224
230 bool RSVP() const;
231
237 //KDE5: make const
238 bool operator==( const Attendee &attendee ); //krazy:exclude=operators
239
246 void setDelegate( const QString &delegate );
247
252 QString delegate() const;
253
260 void setDelegator( const QString &delegator );
261
266 QString delegator() const;
267
274 void setCustomProperty( const QByteArray &xname, const QString &xvalue );
275
280 CustomProperties &customProperties();
281
286 const CustomProperties &customProperties() const;
287
293 Attendee &operator=( const Attendee &attendee );
294
295 private:
296 //@cond PRIVATE
297 class Private;
298 Private *const d;
299 //@endcond
300};
301
302}
303
304#endif
KCal::Attendee::customProperties
CustomProperties & customProperties()
Returns a reference to the CustomProperties object.
Definition attendee.cpp:260
KCal::Attendee::email
QString email() const
Returns the email address for this person.
Definition person.cpp:144
KCal::Attendee::setStatus
void setStatus(PartStat status)
Sets the PartStat of the attendee to status.
Definition attendee.cpp:120
KCal::Attendee::statusName
static QString statusName(PartStat status)
Returns the specified PartStat status as a text string.
Definition attendee.cpp:135
KCal::Attendee::setDelegator
void setDelegator(const QString &delegator)
Sets the delegator.
Definition attendee.cpp:245
KCal::Attendee::setUid
void setUid(const QString &uid)
Sets the UID of the attendee to uid.
Definition attendee.cpp:195
KCal::Attendee::statusList
static QStringList statusList()
Returns a list of strings representing each PartStat.
Definition attendee.cpp:166
KCal::Attendee::RSVP
bool RSVP() const
Returns the attendee RSVP flag.
Definition attendee.cpp:115
KCal::Attendee::setRole
void setRole(Role role)
Sets the Role of the attendee to role.
Definition attendee.cpp:180
KCal::Attendee::roleStr
QString roleStr() const
Returns the attendee Role as a text string.
Definition attendee.cpp:190
KCal::Attendee::statusStr
QString statusStr() const
Returns the attendee PartStat as a text string.
Definition attendee.cpp:130
KCal::Attendee::name
QString name() const
Returns the person name string.
Definition person.cpp:139
KCal::Attendee::PartStat
PartStat
The different types of participant status.
Definition attendee.h:71
KCal::Attendee::Delegated
@ Delegated
Event or to-do delegated.
Definition attendee.h:76
KCal::Attendee::Tentative
@ Tentative
Event or to-do tentatively accepted.
Definition attendee.h:75
KCal::Attendee::Accepted
@ Accepted
Event, to-do or journal accepted.
Definition attendee.h:73
KCal::Attendee::Completed
@ Completed
To-do completed.
Definition attendee.h:77
KCal::Attendee::NeedsAction
@ NeedsAction
Event, to-do or journal needs action (default)
Definition attendee.h:72
KCal::Attendee::Declined
@ Declined
Event, to-do or journal declined.
Definition attendee.h:74
KCal::Attendee::InProcess
@ InProcess
To-do in process of being completed.
Definition attendee.h:78
KCal::Attendee::roleList
static QStringList roleList()
Returns a list of strings representing each Role.
Definition attendee.cpp:224
KCal::Attendee::setDelegate
void setDelegate(const QString &delegate)
Sets the delegate.
Definition attendee.cpp:235
KCal::Attendee::delegate
QString delegate() const
Returns the delegate.
Definition attendee.cpp:240
KCal::Attendee::roleName
static QString roleName(Role role)
Returns the specified Role role as a text string.
Definition attendee.cpp:205
KCal::Attendee::Role
Role
The different types of participation roles.
Definition attendee.h:85
KCal::Attendee::NonParticipant
@ NonParticipant
Non-Participant; copied for information purposes.
Definition attendee.h:88
KCal::Attendee::ReqParticipant
@ ReqParticipant
Participation is required (default)
Definition attendee.h:86
KCal::Attendee::OptParticipant
@ OptParticipant
Participation is optional.
Definition attendee.h:87
KCal::Attendee::Chair
@ Chair
Chairperson.
Definition attendee.h:89
KCal::Attendee::role
Role role() const
Returns the Role of the attendee.
Definition attendee.cpp:185
KCal::Attendee::operator=
Attendee & operator=(const Attendee &attendee)
Sets this attendee equal to attendee.
Definition attendee.cpp:97
KCal::Attendee::operator==
bool operator==(const Attendee &attendee)
Compares this with attendee for equality.
Definition attendee.cpp:85
KCal::Attendee::setRSVP
void setRSVP(bool rsvp)
Sets the RSVP flag of the attendee to rsvp.
Definition attendee.cpp:110
KCal::Attendee::delegator
QString delegator() const
Returns the delegator.
Definition attendee.cpp:250
KCal::Attendee::List
ListBase< Attendee > List
List of attendees.
Definition attendee.h:95
KCal::Attendee::uid
QString uid() const
Returns the UID of the attendee.
Definition attendee.cpp:200
KCal::Attendee::setCustomProperty
void setCustomProperty(const QByteArray &xname, const QString &xvalue)
Adds a custom property.
Definition attendee.cpp:255
KCal::Attendee::Attendee
Attendee(const QString &name, const QString &email, bool rsvp=false, PartStat status=None, Role role=ReqParticipant, const QString &uid=QString())
Constructs an attendee consisting of a Person name (name) and email address (email); invitation statu...
Definition attendee.cpp:62
KCal::Attendee::status
PartStat status() const
Returns the PartStat of the attendee.
Definition attendee.cpp:125
KCal::CustomProperties
A class to manage custom calendar properties.
Definition customproperties.h:53
KCal::ListBase
This class provides a template for lists of pointers.
Definition listbase.h:45
KCal::Person::Person
Person()
Constructs a blank person.
Definition person.cpp:58
KCal::Person::email
QString email() const
Returns the email address for this person.
Definition person.cpp:144
KCal::Person::name
QString name() const
Returns the person name string.
Definition person.cpp:139
KCal::Person::setEmail
void setEmail(const QString &email)
Sets the email address for this person to email.
Definition person.cpp:159
KCal::Person::fullName
QString fullName() const
Returns the full name of this person.
Definition person.cpp:114
KCal::Person::setName
void setName(const QString &name)
Sets the name of the person to name.
Definition person.cpp:154
customproperties.h
This file is part of the API for handling calendar data and defines the CustomProperties class.
listbase.h
This file is part of the API for handling calendar data and defines the ListBase class.
person.h
This file is part of the API for handling calendar data and defines the Person class.
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal