libkcal/attendee.h

   1 /*
   2     This file is part of libkcal.
   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., 59 Temple Place - Suite 330,
  19     Boston, MA 02111-1307, USA.
  20 */
  21
  22 #ifndef KCAL_ATTENDEE_H
  23 #define KCAL_ATTENDEE_H
  24
  25 #include <qstring.h>
  26
  27 #include "listbase.h"
  28 #include "person.h"
  29
  30 namespace KCal {
  31
  32 /**
  33   This class represents information related to an attendee of an event.
  34 */
  35 class Attendee : public Person
  36 {
  37   public:
  38     enum PartStat { NeedsAction, Accepted, Declined, Tentative,
  39                     Delegated, Completed, InProcess };
  40     enum Role { ReqParticipant, OptParticipant, NonParticipant, Chair };
  41
  42     typedef ListBase<Attendee> List;
  43
  44     /**
  45       Create Attendee.
  46
  47       @param name Name
  48       @param email Email address
  49       @param rsvp Request for reply
  50       @param status Status (see enum for list)
  51       @param role Role
  52       @param u the uid for the attendee
  53     */
  54     Attendee( const QString &name, const QString &email,
  55               bool rsvp = false, PartStat status = NeedsAction,
  56               Role role = ReqParticipant, const QString &u = QString::null );
  57     /**
  58       Destruct Attendee.
  59     */
  60     virtual ~Attendee();
  61
  62     /**
  63       Set role of Attendee.
  64     */
  65     // FIXME: List of roles still has to be documented.
  66     void setRole( Role );
  67
  68     /**
  69       Return role of Attendee.
  70     */
  71     Role role() const;
  72
  73     /**
  74       Return role as clear text string.
  75     */
  76     QString roleStr() const;
  77     /**
  78       Return string represenation of role.
  79     */
  80     static QString roleName( Role );
  81     /**
  82       Return string representations of all available roles.
  83     */
  84     static QStringList roleList();
  85
  86     /**
  87       Return unique id of the attendee.
  88     */
  89     QString uid() const;
  90     /**
  91       Set unique id of attendee.
  92     */
  93     void setUid ( const QString & );
  94
  95     /**
  96       Set status. See enum for definitions of possible values.
  97     */
  98     void setStatus( PartStat s );
  99
 100     /**
 101       Return status.
 102     */
 103     PartStat status() const;
 104
 105     /**
 106       Return status as human-readable string.
 107     */
 108     QString statusStr() const;
 109     /**
 110       Return string representation of attendee status.
 111     */
 112     static QString statusName( PartStat );
 113     /**
 114       Return string representations of all available attendee status values.
 115     */
 116     static QStringList statusList();
 117
 118     /**
 119       Set if Attendee is asked to reply.
 120     */
 121     void setRSVP( bool r ) { mRSVP = r; }
 122     /**
 123       Return, if Attendee is asked to reply.
 124     */
 125     bool RSVP() const { return mRSVP; }
 126
 127   private:
 128     bool mRSVP;
 129     Role mRole;
 130     PartStat mStatus;
 131     QString mUid;
 132
 133     class Private;
 134     Private *d;
 135 };
 136
 137 bool operator==( const Attendee& a1, const Attendee& a2 );
 138
 139 }
 140
 141 #endif