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

KCal Library

  • sources
  • kde-4.12
  • kdepimlibs
  • 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 */
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 
39 namespace KCal {
40 
58 class 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::Person::email
QString email() const
Returns the email address for this person.
Definition: person.cpp:144
KCal::CustomProperties
A class to manage custom calendar properties.
Definition: customproperties.h:52
customproperties.h
This file is part of the API for handling calendar data and defines the CustomProperties class...
KCal::Attendee
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (...
Definition: attendee.h:58
KCal::Attendee::InProcess
To-do in process of being completed.
Definition: attendee.h:78
KCal::Attendee::Completed
To-do completed.
Definition: attendee.h:77
KCal::Attendee::List
ListBase< Attendee > List
List of attendees.
Definition: attendee.h:95
person.h
This file is part of the API for handling calendar data and defines the Person class.
KCal::Attendee::PartStat
PartStat
The different types of participant status.
Definition: attendee.h:71
KCal::Attendee::Declined
Event, to-do or journal declined.
Definition: attendee.h:74
KCal::Person::setEmail
void setEmail(const QString &email)
Sets the email address for this person to email.
Definition: person.cpp:159
KCal::Attendee::Role
Role
The different types of participation roles.
Definition: attendee.h:85
KCal::Attendee::NonParticipant
Non-Participant; copied for information purposes.
Definition: attendee.h:88
KCal::Person
Represents a person, by name ane email address.
Definition: person.h:48
KCal::Person::name
QString name() const
Returns the person name string.
Definition: person.cpp:139
listbase.h
This file is part of the API for handling calendar data and defines the ListBase class.
KCal::ListBase
This class provides a template for lists of pointers.
Definition: listbase.h:44
KCal::Person::setName
void setName(const QString &name)
Sets the name of the person to name.
Definition: person.cpp:154
KCal::Attendee::Accepted
Event, to-do or journal accepted.
Definition: attendee.h:73
KCal::Attendee::NeedsAction
Event, to-do or journal needs action (default)
Definition: attendee.h:72
KCal::Attendee::ReqParticipant
Participation is required (default)
Definition: attendee.h:86
KCal::Person::fullName
QString fullName() const
Returns the full name of this person.
Definition: person.cpp:114
KCal::Attendee::OptParticipant
Participation is optional.
Definition: attendee.h:87
KCal::Attendee::Delegated
Event or to-do delegated.
Definition: attendee.h:76
KCal::Attendee::Tentative
Event or to-do tentatively accepted.
Definition: attendee.h:75
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:57 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

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