incidencechanger.h

/*
  Copyright (C) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (C) 2010-2012 Sérgio Martins <iamsergio@gmail.com>

  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 AKONADI_INCIDENCECHANGER_H
#define AKONADI_INCIDENCECHANGER_H

#include "akonadi-calendar_export.h"

#include <akonadi/item.h>
#include <akonadi/collection.h>
#include <kcalcore/incidence.h>

#include <QWidget>

namespace Akonadi {

class History;

class AKONADI_CALENDAR_EXPORT IncidenceChanger : public QObject
{
    Q_OBJECT
public:
    enum ResultCode {
        ResultCodeSuccess = 0,
        ResultCodeJobError, 
        ResultCodeAlreadyDeleted, 
        ResultCodeInvalidDefaultCollection, 
        ResultCodeRolledback, 
        ResultCodePermissions, 
        ResultCodeUserCanceled, 
        ResultCodeInvalidUserCollection, 
        ResultCodeModificationDiscarded, 
        ResultCodeDuplicateId 
    };

    enum DestinationPolicy {
        DestinationPolicyDefault, 
        DestinationPolicyAsk,     
        DestinationPolicyNeverAsk 
    };

    enum InvitationPolicy {
        InvitationPolicySend = 0, 
        InvitationPolicyAsk,      
        InvitationPolicyDontSend  
    };

    enum ChangeType {
        ChangeTypeCreate,   
        ChangeTypeModify,   
        ChangeTypeDelete    
    };

    explicit IncidenceChanger(QObject *parent = 0);

    ~IncidenceChanger();

    int createIncidence(const KCalCore::Incidence::Ptr &incidence,
                        const Akonadi::Collection &collection = Akonadi::Collection(),
                        QWidget *parent = 0);

    int deleteIncidence(const Akonadi::Item &item, QWidget *parent = 0);

    int deleteIncidences(const Akonadi::Item::List &items, QWidget *parent = 0);

    int modifyIncidence(const Akonadi::Item &item,
                        const KCalCore::Incidence::Ptr &originalPayload = KCalCore::Incidence::Ptr(),
                        QWidget *parent = 0);

    void startAtomicOperation(const QString &operationDescription = QString());

    void endAtomicOperation();

    void setDefaultCollection(const Akonadi::Collection &collection);

    Akonadi::Collection defaultCollection() const;

    void setDestinationPolicy(DestinationPolicy destinationPolicy);

    DestinationPolicy destinationPolicy() const;

    void setShowDialogsOnError(bool enable);

    bool showDialogsOnError() const;

    void setRespectsCollectionRights(bool respect);

    bool respectsCollectionRights() const;

    void setHistoryEnabled(bool enable);

    bool historyEnabled() const;

    History* history() const;

    bool deletedRecently(Akonadi::Item::Id) const;

    void setGroupwareCommunication(bool enabled);

    bool groupwareCommunication() const;

    void setAutoAdjustRecurrence(bool enable);

    bool autoAdjustRecurrence() const;

    void setInvitationPolicy(InvitationPolicy policy);

    InvitationPolicy invitationPolicy() const;

    Akonadi::Collection lastCollectionUsed() const;

Q_SIGNALS:
    void createFinished(int changeId,
                        const Akonadi::Item &item,
                        Akonadi::IncidenceChanger::ResultCode resultCode,
                        const QString &errorString);
    void modifyFinished(int changeId,
                        const Akonadi::Item &item,
                        Akonadi::IncidenceChanger::ResultCode resultCode,
                        const QString &errorString);
    void deleteFinished(int changeId,
                        const QVector<Akonadi::Item::Id> &itemIdList,
                        Akonadi::IncidenceChanger::ResultCode resultCode,
                        const QString &errorString);

private:
    //@cond PRIVATE
    friend class History;
    friend class AtomicOperation;
    // used internally by the History class
    explicit IncidenceChanger(bool enableHistory, QObject *parent = 0);
    class Private;
    Private *const d;
    //@endcond
};

}

Q_DECLARE_METATYPE(Akonadi::IncidenceChanger::DestinationPolicy)
Q_DECLARE_METATYPE(Akonadi::IncidenceChanger::ResultCode)
Q_DECLARE_METATYPE(Akonadi::IncidenceChanger::ChangeType)

#endif