mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 02:42:51 +00:00
123 lines
3.5 KiB
C++
123 lines
3.5 KiB
C++
/*
|
|
This file is part of the kcalcore library.
|
|
|
|
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef KCALCORE_SCHEDULEMESSAGE_H
|
|
#define KCALCORE_SCHEDULEMESSAGE_H
|
|
|
|
#include "incidencebase.h"
|
|
|
|
#include "kcalcore_export.h"
|
|
|
|
namespace KCalCore {
|
|
|
|
class IncidenceBase;
|
|
|
|
/**
|
|
iTIP methods.
|
|
*/
|
|
enum iTIPMethod {
|
|
iTIPPublish, /**< Event, to-do, journal or freebusy posting */
|
|
iTIPRequest, /**< Event, to-do or freebusy scheduling request */
|
|
iTIPReply, /**< Event, to-do or freebusy reply to request */
|
|
iTIPAdd, /**< Event, to-do or journal additional property request */
|
|
iTIPCancel, /**< Event, to-do or journal cancellation notice */
|
|
iTIPRefresh, /**< Event or to-do description update request */
|
|
iTIPCounter, /**< Event or to-do submit counter proposal */
|
|
iTIPDeclineCounter,/**< Event or to-do decline a counter proposal */
|
|
iTIPNoMethod /**< No method */
|
|
};
|
|
|
|
/**
|
|
@brief
|
|
A Scheduling message class.
|
|
|
|
This class provides an encapsulation of a scheduling message.
|
|
It associates an incidence with an iTIPMethod and status information.
|
|
*/
|
|
class KCALCORE_EXPORT ScheduleMessage
|
|
{
|
|
public:
|
|
/**
|
|
Message status.
|
|
*/
|
|
enum Status {
|
|
PublishNew, /**< New message posting */
|
|
PublishUpdate, /**< Updated message */
|
|
Obsolete, /**< obsolete */
|
|
RequestNew, /**< Request new message posting */
|
|
RequestUpdate, /**< Request updated message */
|
|
Unknown /**< No status */
|
|
};
|
|
|
|
/**
|
|
A shared pointer to a ScheduleMessage.
|
|
*/
|
|
typedef QSharedPointer<ScheduleMessage> Ptr;
|
|
|
|
/**
|
|
Creates a scheduling message with method as defined in iTIPMethod and a status.
|
|
@param incidence a pointer to a valid Incidence to be associated with this message.
|
|
@param method an iTIPMethod.
|
|
@param status a Status.
|
|
*/
|
|
ScheduleMessage(IncidenceBase::Ptr incidence, iTIPMethod method, Status status);
|
|
|
|
/**
|
|
Destructor.
|
|
*/
|
|
~ScheduleMessage();
|
|
|
|
/**
|
|
Returns the event associated with this message.
|
|
*/
|
|
IncidenceBase::Ptr event() const;
|
|
|
|
/**
|
|
Returns the iTIP method associated with this message.
|
|
*/
|
|
iTIPMethod method() const;
|
|
|
|
/**
|
|
Returns a machine-readable (not translatable) name for a iTIP method.
|
|
@param method an iTIPMethod.
|
|
*/
|
|
static QString methodName(iTIPMethod method);
|
|
|
|
/**
|
|
Returns the status of this message.
|
|
*/
|
|
Status status() const;
|
|
|
|
/**
|
|
Returns the error message if there is any.
|
|
*/
|
|
QString error() const;
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
Q_DISABLE_COPY(ScheduleMessage)
|
|
class Private;
|
|
Private *const d;
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|