calendarsupport/dndfactory.h

   1 /*
   2   Copyright (c) 1998 Preston Brown <pbrown@kde.org>
   3   Copyright (c) 2001,2002,2003 Cornelius Schumacher <schumacher@kde.org>
   4   Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
   5   Copyright (c) 2008 Thomas Thrainer <tom_t@gmx.at>
   6   Copyright (c) 2010 Laurent Montel <montel@kde.org>
   7
   8   Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
   9   Author: Sergio Martins <sergio@kdab.com>
  10
  11   This library is free software; you can redistribute it and/or
  12   modify it under the terms of the GNU Library General Public
  13   License as published by the Free Software Foundation; either
  14   version 2 of the License, or (at your option) any later version.
  15
  16   This library is distributed in the hope that it will be useful,
  17   but WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19   Library General Public License for more details.
  20
  21   You should have received a copy of the GNU Library General Public License
  22   along with this library; see the file COPYING.LIB.  If not, write to
  23   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24   Boston, MA 02110-1301, USA.
  25 */
  26 #ifndef CALENDARSUPPORT_DNDFACTORY_H
  27 #define CALENDARSUPPORT_DNDFACTORY_H
  28
  29 #include "calendarsupport_export.h"
  30 #include "calendaradaptor.h"
  31
  32 #include <KCalUtils/DndFactory>
  33
  34 namespace CalendarSupport {
  35
  36 class CalendarAdaptor;
  37
  38 /**
  39   @brief
  40   vCalendar/iCalendar Drag-and-Drop object factory.
  41
  42   This class implements functions to create Drag and Drop objects used for
  43   Drag-and-Drop and Copy-and-Paste.
  44 */
  45 class CALENDARSUPPORT_EXPORT DndFactory
  46 {
  47   public:
  48     explicit DndFactory( const CalendarSupport::CalendarAdaptor::Ptr &,
  49                          bool deleteCalendarHere = false );
  50
  51     ~DndFactory();
  52
  53     /**
  54       Create the calendar that is contained in the drop event's data.
  55     */
  56     KCalCore::MemoryCalendar::Ptr createDropCalendar( QDropEvent *de );
  57
  58     /**
  59       Create the calendar that is contained in the mime data.
  60     */
  61     KCalCore::MemoryCalendar::Ptr createDropCalendar( const QMimeData *md );
  62
  63     /**
  64       Create the calendar that is contained in the mime data.
  65     */
  66     static KCalCore::MemoryCalendar::Ptr createDropCalendar( const QMimeData *md,
  67                                                              const KDateTime::Spec &timeSpec );
  68
  69     /**
  70       Create the mime data for the whole calendar.
  71     */
  72     QMimeData *createMimeData();
  73
  74     /**
  75       Create a drag object for the whole calendar.
  76     */
  77     QDrag *createDrag( QWidget *owner );
  78
  79     /**
  80       Create the mime data for a single incidence.
  81     */
  82     QMimeData *createMimeData( const KCalCore::Incidence::Ptr &incidence );
  83
  84     /**
  85       Create a drag object for a single incidence.
  86     */
  87     QDrag *createDrag( const KCalCore::Incidence::Ptr &incidence, QWidget *owner );
  88
  89     /**
  90       Create Todo object from mime data.
  91     */
  92     KCalCore::Todo::Ptr createDropTodo( const QMimeData *md );
  93
  94     /**
  95       Create Todo object from drop event.
  96     */
  97     KCalCore::Todo::Ptr createDropTodo( QDropEvent *de );
  98
  99     /**
 100       Create Event object from mime data.
 101     */
 102     KCalCore::Event::Ptr createDropEvent( const QMimeData *md );
 103
 104     /**
 105       Create Event object from drop event.
 106     */
 107     KCalCore::Event::Ptr createDropEvent( QDropEvent *de );
 108
 109     /**
 110       Cut the incidence to the clipboard.
 111     */
 112     void cutIncidence( const Akonadi::Item & );
 113
 114     /**
 115       Copy the incidence to clipboard/
 116     */
 117     bool copyIncidence( const Akonadi::Item & );
 118
 119     /**
 120       Paste the event or todo and return a pointer to the new incidence pasted.
 121     */
 122     KCalCore::Incidence::Ptr pasteIncidence(
 123       const KDateTime &,
 124       const KCalUtils::DndFactory::PasteFlags & = KCalUtils::DndFactory::PasteFlags() );
 125
 126     /**
 127       Pastes and returns the incidences from the clipboard.
 128       If no date and time are given, the incidences will be pasted at their original date/time.
 129     */
 130     KCalCore::Incidence::List pasteIncidences(
 131       const KDateTime &,
 132       const KCalUtils::DndFactory::PasteFlags & = KCalUtils::DndFactory::PasteFlags() );
 133
 134     /**
 135       Cuts a list of incidences to the clipboard.
 136     */
 137     bool cutIncidences( const Akonadi::Item::List &item );
 138
 139     /**
 140       Copies a list of incidences to the clipboard.
 141     */
 142     bool copyIncidences( const Akonadi::Item::List &item );
 143
 144   private:
 145     //@cond PRIVATE
 146     Q_DISABLE_COPY( DndFactory )
 147     class Private;
 148     Private *const d;
 149     //@endcond
 150 };
 151
 152 }
 153
 154 #endif