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

KCal Library

  • kcal
scheduler.h
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*/
21#ifndef KCAL_SCHEDULER_H
22#define KCAL_SCHEDULER_H
23
24#include "kcal_export.h"
25
26#include <QtCore/QString>
27#include <QtCore/QList>
28
29namespace KCal {
30
34enum iTIPMethod {
35 iTIPPublish,
36 iTIPRequest,
37 iTIPReply,
38 iTIPAdd,
39 iTIPCancel,
40 iTIPRefresh,
41 iTIPCounter,
42 iTIPDeclineCounter,
43 iTIPNoMethod
44};
45
46class IncidenceBase;
47class Calendar;
48class ICalFormat;
49class FreeBusyCache;
50
58class KCAL_DEPRECATED_EXPORT ScheduleMessage
59{
60 public:
64 enum Status {
65 PublishNew,
66 PublishUpdate,
67 Obsolete,
68 RequestNew,
69 RequestUpdate,
70 Unknown
71 };
72
77 ScheduleMessage( IncidenceBase *incidence, iTIPMethod method, Status status );
78
82 ~ScheduleMessage();
83
87 IncidenceBase *event();
88
92 iTIPMethod method();
93
97 Status status();
98
102 static QString statusName( Status status );
103
107 QString error();
108
109 private:
110 Q_DISABLE_COPY( ScheduleMessage )
111 class Private;
112 Private *const d;
113};
114
120class KCAL_DEPRECATED_EXPORT Scheduler
121{
122 public:
126 explicit Scheduler( Calendar *calendar );
127 virtual ~Scheduler();
128
132 virtual bool publish( IncidenceBase *incidence,
133 const QString &recipients ) = 0;
141 virtual bool performTransaction( IncidenceBase *incidence,
142 iTIPMethod method ) = 0;
143
153 virtual bool performTransaction( IncidenceBase *incidence,
154 iTIPMethod method,
155 const QString &recipients ) = 0;
156
160 virtual QList<ScheduleMessage*> retrieveTransactions() = 0;
161
166 bool KCAL_DEPRECATED acceptTransaction( IncidenceBase *incidence, iTIPMethod method,
167 ScheduleMessage::Status status );
168
181 bool acceptTransaction( IncidenceBase *incidence,
182 iTIPMethod method,
183 ScheduleMessage::Status status,
184 const QString &email );
185
189 static QString methodName( iTIPMethod method );
190
194 static QString translatedMethodName( iTIPMethod method );
195
196 virtual bool deleteTransaction( IncidenceBase *incidence );
197
201 virtual QString freeBusyDir() = 0;
202
206 void setFreeBusyCache( FreeBusyCache * );
207
211 FreeBusyCache *freeBusyCache() const;
212
213 protected:
214 bool acceptPublish( IncidenceBase *, ScheduleMessage::Status status, iTIPMethod method );
219 bool KCAL_DEPRECATED acceptRequest( IncidenceBase *, ScheduleMessage::Status status );
220 bool acceptRequest( IncidenceBase *, ScheduleMessage::Status status,
221 const QString &email );
222 bool acceptAdd( IncidenceBase *, ScheduleMessage::Status status );
223 KCAL_DEPRECATED bool acceptCancel( IncidenceBase *, ScheduleMessage::Status status );
224 bool acceptCancel( IncidenceBase *, ScheduleMessage::Status status,
225 const QString & attendee );
226 bool acceptDeclineCounter( IncidenceBase *, ScheduleMessage::Status status );
227 bool acceptReply( IncidenceBase *, ScheduleMessage::Status status, iTIPMethod method );
228 bool acceptRefresh( IncidenceBase *, ScheduleMessage::Status status );
229 bool acceptCounter( IncidenceBase *, ScheduleMessage::Status status );
230 bool acceptFreeBusy( IncidenceBase *, iTIPMethod method );
231
232 Calendar *mCalendar;
233 ICalFormat *mFormat;
234
235 private:
236 Q_DISABLE_COPY( Scheduler )
237 struct Private;
238 Private *const d;
239};
240
241}
242
243#endif
KCal::Calendar
Represents the main calendar class.
Definition calendar.h:121
KCal::FreeBusyCache
An abstract base class to allow different implementations of storing free busy information,...
Definition freebusycache.h:45
KCal::ICalFormat
iCalendar format implementation.
Definition icalformat.h:53
KCal::IncidenceBase
An abstract class that provides a common base for all calendar incidence classes.
Definition incidencebase.h:103
KCal::ScheduleMessage
A Scheduling message class.
Definition scheduler.h:59
KCal::ScheduleMessage::Status
Status
Message status.
Definition scheduler.h:64
KCal::ScheduleMessage::RequestUpdate
@ RequestUpdate
Request updated message.
Definition scheduler.h:69
KCal::ScheduleMessage::PublishNew
@ PublishNew
New message posting.
Definition scheduler.h:65
KCal::ScheduleMessage::RequestNew
@ RequestNew
Request new message posting.
Definition scheduler.h:68
KCal::ScheduleMessage::PublishUpdate
@ PublishUpdate
Updated message.
Definition scheduler.h:66
KCal::ScheduleMessage::Obsolete
@ Obsolete
obsolete
Definition scheduler.h:67
KCal::Scheduler
This class provides an encapsulation of iTIP transactions (RFC 2446).
Definition scheduler.h:121
KCal::Scheduler::performTransaction
virtual bool performTransaction(IncidenceBase *incidence, iTIPMethod method, const QString &recipients)=0
Performs iTIP transaction on incidence to specified recipient(s).
KCal::Scheduler::retrieveTransactions
virtual QList< ScheduleMessage * > retrieveTransactions()=0
Retrieves incoming iTIP transactions.
KCal::Scheduler::publish
virtual bool publish(IncidenceBase *incidence, const QString &recipients)=0
iTIP publish action
KCal::Scheduler::freeBusyDir
virtual QString freeBusyDir()=0
Returns the directory where the free-busy information is stored.
KCal::Scheduler::performTransaction
virtual bool performTransaction(IncidenceBase *incidence, iTIPMethod method)=0
Performs iTIP transaction on incidence.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 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