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

KCalCore Library

  • sources
  • kde-4.14
  • kdepimlibs
  • kcalcore
attendee.h
Go to the documentation of this file.
1 /*
2  This file is part of the kcalcore 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 */
29 #ifndef KCALCORE_ATTENDEE_H
30 #define KCALCORE_ATTENDEE_H
31 
32 #include <QtCore/QMetaType>
33 
34 #include "kcalcore_export.h"
35 #include "customproperties.h"
36 #include "person.h"
37 
38 namespace KCalCore {
39 
57 class KCALCORE_EXPORT Attendee : private Person
58 {
59 public:
60  using Person::setEmail;
61  using Person::email;
62  using Person::setName;
63  using Person::name;
64  using Person::fullName;
65 
70  enum PartStat {
71  NeedsAction,
72  Accepted,
73  Declined,
74  Tentative,
75  Delegated,
76  Completed,
77  InProcess,
78  None
79  };
80 
84  enum Role {
85  ReqParticipant,
86  OptParticipant,
87  NonParticipant,
88  Chair
89  };
90 
91 
97  enum CuType {
98  Individual,
99  Group,
100  Resource,
101  Room,
102  Unknown
108  };
109 
113  typedef QSharedPointer<Attendee> Ptr;
114 
118  typedef QVector<Ptr> List;
119 
132  Attendee(const QString &name, const QString &email,
133  bool rsvp = false, PartStat status = None,
134  Role role = ReqParticipant, const QString &uid = QString());
135 
141  Attendee(const Attendee &attendee);
142 
146  ~Attendee();
147 
155  void setRole(Role role);
156 
162  Role role() const;
163 
171  void setUid(const QString &uid);
172 
178  QString uid() const;
179 
187  void setStatus(PartStat status);
188 
194  PartStat status() const;
195 
205  void setCuType(CuType cuType);
206 
216  void setCuType(const QString &cuType);
217 
218 
226  CuType cuType() const;
227 
235  QString cuTypeStr() const;
236 
237 
246  void setRSVP(bool rsvp);
247 
253  bool RSVP() const;
254 
260  bool operator==(const Attendee &attendee) const;
261 
267  bool operator!=(const Attendee &attendee) const;
268 
275  void setDelegate(const QString &delegate);
276 
281  QString delegate() const;
282 
289  void setDelegator(const QString &delegator);
290 
295  QString delegator() const;
296 
302  void setCustomProperty(const QByteArray &xname, const QString &xvalue);
303 
307  CustomProperties &customProperties();
308 
312  const CustomProperties &customProperties() const;
313 
319  Attendee &operator=(const Attendee &attendee);
320 
321 private:
322  //@cond PRIVATE
323  class Private;
324  Private *const d;
325  //@endcond
326 
327  friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s,
328  const KCalCore::Attendee::Ptr &attendee);
329  friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s,
330  KCalCore::Attendee::Ptr &attendee);
331 };
332 
338 KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
339  const KCalCore::Attendee::Ptr &attendee);
340 
346 KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
347  KCalCore::Attendee::Ptr &attendee);
348 }
349 
350 //@cond PRIVATE
351 Q_DECLARE_TYPEINFO(KCalCore::Attendee::Ptr, Q_MOVABLE_TYPE);
352 Q_DECLARE_METATYPE(KCalCore::Attendee::Ptr)
353 //@endcond
354 
355 #endif
customproperties.h
This file is part of the API for handling calendar data and defines the CustomProperties class...
KCalCore::Person
Represents a person, by name and email address.
Definition: person.h:50
KCalCore::Attendee::Individual
An individual (default)
Definition: attendee.h:98
KCalCore::Attendee::Group
A group of individuals.
Definition: attendee.h:99
QByteArray
KCalCore::Attendee::NonParticipant
Non-Participant; copied for information purposes.
Definition: attendee.h:87
QDataStream
KCalCore::Person::setEmail
void setEmail(const QString &email)
Sets the email address for this person to email.
Definition: person.cpp:146
KCalCore::Person::name
QString name() const
Returns the person name string.
Definition: person.cpp:126
KCalCore::Attendee::Role
Role
The different types of participation roles.
Definition: attendee.h:84
KCalCore::Person::fullName
QString fullName() const
Returns the full name of this person.
Definition: person.cpp:101
person.h
This file is part of the API for handling calendar data and defines the Person class.
KCalCore::Person::setName
void setName(const QString &name)
Sets the name of the person to name.
Definition: person.cpp:141
KCalCore::Attendee::CuType
CuType
The different types of a participant.
Definition: attendee.h:97
KCalCore::Attendee::Delegated
Event or to-do delegated.
Definition: attendee.h:75
QSharedPointer
KCalCore::Attendee::PartStat
PartStat
The different types of participant status.
Definition: attendee.h:70
KCalCore::Attendee::ReqParticipant
Participation is required (default)
Definition: attendee.h:85
QString
KCalCore::Attendee::OptParticipant
Participation is optional.
Definition: attendee.h:86
KCalCore::Person::email
QString email() const
Returns the email address for this person.
Definition: person.cpp:131
KCalCore::operator>>
KCALCORE_EXPORT QDataStream & operator>>(QDataStream &in, const KCalCore::Alarm::Ptr &)
Alarm deserializer.
Definition: alarm.cpp:863
KCalCore::Attendee::InProcess
To-do in process of being completed.
Definition: attendee.h:77
KCalCore::Attendee::NeedsAction
Event, to-do or journal needs action (default)
Definition: attendee.h:71
QVector
KCalCore::Attendee::Ptr
QSharedPointer< Attendee > Ptr
A shared pointer to an Attendee object.
Definition: attendee.h:113
KCalCore::Attendee::Completed
To-do completed.
Definition: attendee.h:76
KCalCore::CustomProperties
A class to manage custom calendar properties.
Definition: customproperties.h:51
KCalCore::Attendee::Tentative
Event or to-do tentatively accepted.
Definition: attendee.h:74
KCalCore::Attendee::List
QVector< Ptr > List
List of attendees.
Definition: attendee.h:118
KCalCore::Attendee::Room
A room resource.
Definition: attendee.h:101
KCalCore::Attendee
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (...
Definition: attendee.h:57
KCalCore::Attendee::Resource
A physical resource.
Definition: attendee.h:100
KCalCore::operator<<
KCALCORE_EXPORT QDataStream & operator<<(QDataStream &out, const KCalCore::Alarm::Ptr &)
Alarm serializer.
Definition: alarm.cpp:853
KCalCore::Attendee::Accepted
Event, to-do or journal accepted.
Definition: attendee.h:72
KCalCore::Attendee::Declined
Event, to-do or journal declined.
Definition: attendee.h:73
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:36:53 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

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

kdepimlibs API Reference

Skip menu "kdepimlibs 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

Search



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