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

KCalCore Library

  • 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 
94  typedef QSharedPointer<Attendee> Ptr;
95 
99  typedef QVector<Ptr> List;
100 
113  Attendee( const QString &name, const QString &email,
114  bool rsvp = false, PartStat status = None,
115  Role role = ReqParticipant, const QString &uid = QString() );
116 
122  Attendee( const Attendee &attendee );
123 
127  ~Attendee();
128 
136  void setRole( Role role );
137 
143  Role role() const;
144 
152  void setUid ( const QString &uid );
153 
159  QString uid() const;
160 
168  void setStatus( PartStat status );
169 
175  PartStat status() const;
176 
185  void setRSVP( bool rsvp );
186 
192  bool RSVP() const;
193 
199  bool operator==( const Attendee &attendee ) const;
200 
206  bool operator!=( const Attendee &attendee ) const;
207 
214  void setDelegate( const QString &delegate );
215 
220  QString delegate() const;
221 
228  void setDelegator( const QString &delegator );
229 
234  QString delegator() const;
235 
241  void setCustomProperty( const QByteArray &xname, const QString &xvalue );
242 
246  CustomProperties &customProperties();
247 
251  const CustomProperties &customProperties() const;
252 
258  Attendee &operator=( const Attendee &attendee );
259 
260  private:
261  //@cond PRIVATE
262  class Private;
263  Private *const d;
264  //@endcond
265 
266  friend KCALCORE_EXPORT QDataStream &operator<<( QDataStream &s,
267  const KCalCore::Attendee::Ptr &attendee );
268  friend KCALCORE_EXPORT QDataStream &operator>>( QDataStream &s,
269  KCalCore::Attendee::Ptr &attendee );
270 };
271 
277 KCALCORE_EXPORT QDataStream &operator<<( QDataStream &stream,
278  const KCalCore::Attendee::Ptr &attendee );
279 
285 KCALCORE_EXPORT QDataStream &operator>>( QDataStream &stream,
286  KCalCore::Attendee::Ptr &attendee );
287 }
288 
289 //@cond PRIVATE
290 Q_DECLARE_TYPEINFO( KCalCore::Attendee::Ptr, Q_MOVABLE_TYPE );
291 Q_DECLARE_METATYPE( KCalCore::Attendee::Ptr )
292 //@endcond
293 
294 #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::NonParticipant
Non-Participant; copied for information purposes.
Definition: attendee.h:87
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::Delegated
Event or to-do delegated.
Definition: attendee.h:75
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
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::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
KCalCore::Attendee::Ptr
QSharedPointer< Attendee > Ptr
A shared pointer to an Attendee object.
Definition: attendee.h:94
KCalCore::Attendee::Completed
To-do completed.
Definition: attendee.h:76
KCalCore::operator<<
KCALCORE_EXPORT QDataStream & operator<<(QDataStream &stream, const KCalCore::Attendee::Ptr &attendee)
Serializes an Attendee object into a data stream.
Definition: attendee.cpp:186
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:99
KCalCore::Attendee
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (...
Definition: attendee.h:57
KCalCore::Attendee::Accepted
Event, to-do or journal accepted.
Definition: attendee.h:72
KCalCore::operator>>
KCALCORE_EXPORT QDataStream & operator>>(QDataStream &stream, KCalCore::Attendee::Ptr &attendee)
Initializes an Attendee object from a data stream.
Definition: attendee.cpp:199
KCalCore::Attendee::Declined
Event, to-do or journal declined.
Definition: attendee.h:73
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:02:04 by doxygen 1.8.5 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-4.11.3 API Reference

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