File indexing completed on 2024-05-19 05:11:14

 /*
    SPDX-FileCopyrightText: 2012 Sérgio Martins <iamsergio@gmail.com>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadi-calendar_export.h"
 #include "calendarbase.h"
 
 #include <KCalendarCore/Incidence>
 #include <QObject>
 
 #include <memory>
 
 namespace Akonadi
 {
 class IncidenceChanger;
 class CalendarClipboardPrivate;
 
 /**
  * @short Class to copy or cut calendar incidences.
  *
  * @author Sérgio Martins <iamsergio@gmail.com>
  * @since 4.11
  */
 class AKONADI_CALENDAR_EXPORT CalendarClipboard : public QObject
 {
     Q_OBJECT
 public:
     enum Mode {
         SingleMode = 0, ///< Only the specified incidence is cut/copied.
         RecursiveMode, ///< The specified incidence's children are also cut/copied
         AskMode ///< The user is asked if he wants children to be cut/copied too
     };
 
     /**
      * Constructs a new CalendarClipboard.
      * @param calendar calendar containing incidences
      * @param changer incidence changer that will delete incidences while copying.
      *        If 0, an internal one will be created.
      * @param parent QObject parent
      */
     explicit CalendarClipboard(const Akonadi::CalendarBase::Ptr &calendar, Akonadi::IncidenceChanger *changer = nullptr, QObject *parent = nullptr);
     /**
      * Destroys the CalendarClipboard instance.
      */
     ~CalendarClipboard() override;
 
     /**
      * Copies the specified incidence into the clipboard and then deletes it from akonadi.
      * The incidence must be present in the calendar.
      * After it's deletion from akonadi, signal cutFinished() is emitted.
      * @param incidence to cut
      * @param mode how to treat child incidences. Defaults to #RecursiveMode
      * @see cutFinished().
      */
     void cutIncidence(const KCalendarCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode = RecursiveMode);
 
     /**
      * Copies the specified incidence into the clipboard.
      * @param incidence the incidence to copy
      * @param mode how to treat child incidences. Defaults to #RecursiveMode
      * @return true on success
      */
     bool copyIncidence(const KCalendarCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode = RecursiveMode);
 
     /**
      * Returns if there's any ical mime data available for pasting.
      */
     [[nodiscard]] bool pasteAvailable() const;
 
 Q_SIGNALS:
     /**
      * Emitted after cutIncidences() finishes.
      * @param success true if the cut was successful
      * @param errorMessage if @p success if false, contains the error message, empty otherwise.
      */
     void cutFinished(bool success, const QString &errorMessage);
 
 private:
     std::unique_ptr<CalendarClipboardPrivate> const d;
 };
 }