sd/source/ui/slidesorter/inc/controller/SlsClipboard.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SlsClipboard.hxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef SD_SLIDESORTER_CLIPBOARD
  31 #define SD_SLIDESORTER_CLIPBOARD
  32
  33 #include "ViewClipboard.hxx"
  34
  35 #include <sal/types.h>
  36 #include <tools/solar.h>
  37 #include <svx/svdpage.hxx>
  38
  39 #include <set>
  40
  41 class SfxRequest;
  42 class Window;
  43
  44 struct AcceptDropEvent;
  45 class DropTargetHelper;
  46 struct ExecuteDropEvent;
  47 class Point;
  48 class SdPage;
  49 class Window;
  50
  51 namespace sd {
  52 class Window;
  53 }
  54
  55 namespace sd { namespace slidesorter {
  56 class SlideSorter;
  57 } }
  58
  59 namespace sd { namespace slidesorter { namespace model {
  60 class PageDescriptor;
  61 } } }
  62
  63 namespace sd { namespace slidesorter { namespace controller {
  64
  65 class SlideSorterController;
  66
  67 class Clipboard
  68     : public ViewClipboard
  69 {
  70 public:
  71     Clipboard (SlideSorter& rSlideSorter);
  72     ~Clipboard (void);
  73
  74     void HandleSlotCall (SfxRequest& rRequest);
  75
  76     void DoCut (::Window* pWindow = 0);
  77     void DoCopy (::Window* pWindow = 0);
  78     void DoPaste (::Window* pWindow = 0);
  79     void DoDelete (::Window* pWindow = 0);
  80
  81     void StartDrag (
  82         const Point& rDragPt,
  83         ::Window* pWindow );
  84
  85     void DragFinished (
  86         sal_Int8 nDropAction);
  87
  88     sal_Int8 AcceptDrop (
  89         const AcceptDropEvent& rEvt,
  90         DropTargetHelper& rTargetHelper,
  91         ::sd::Window* pTargetWindow = NULL,
  92         USHORT nPage = SDRPAGE_NOTFOUND,
  93         USHORT nLayer = SDRPAGE_NOTFOUND );
  94
  95     sal_Int8 ExecuteDrop (
  96         const ExecuteDropEvent& rEvt,
  97         DropTargetHelper& rTargetHelper,
  98         ::sd::Window* pTargetWindow = NULL,
  99         USHORT nPage = SDRPAGE_NOTFOUND,
 100         USHORT nLayer = SDRPAGE_NOTFOUND);
 101
 102 protected:
 103     virtual USHORT DetermineInsertPosition (
 104         const SdTransferable& rTransferable);
 105
 106     virtual USHORT InsertSlides (
 107         const SdTransferable& rTransferable,
 108         USHORT nInsertPosition);
 109
 110 private:
 111     SlideSorter& mrSlideSorter;
 112     SlideSorterController& mrController;
 113
 114     typedef ::std::vector<SdPage*> PageList;
 115     /** Remember the pages that are dragged to another document or to
 116         another place in the same document so that they can be removed after
 117         a move operation.
 118     */
 119     PageList maPagesToRemove;
 120
 121     /** Remember the pages inserted from another document or another place
 122         in the same document so that they can be selected after the
 123         drag-and-drop operation is completed.
 124     */
 125     PageList maPagesToSelect;
 126
 127     /** When pages are moved or copied then the selection of the slide
 128         sorter has to be updated.  This flag is used to remember whether the
 129         selection has to be updated or can stay as it is (FALSE).
 130     */
 131     bool mbUpdateSelectionPending;
 132
 133     void CreateSlideTransferable (
 134         ::Window* pWindow,
 135         bool bDrag);
 136
 137     /** Select the pages stored in the maPagesToSelect member.  The list in
 138         the member is cleared afterwards.
 139     */
 140     void SelectPages (void);
 141
 142     /** Determine the position of where to insert the pages in the current
 143         transferable of the sd module.
 144         @param pWindow
 145             This window is used as parent for dialogs that have to be shown
 146             to the user.
 147         @return
 148             The index in the range [0,n] (both inclusive) with n the number
 149             of pages is returned.
 150     */
 151     sal_Int32 GetInsertionPosition (::Window* pWindow);
 152
 153     /** Paste the pages of the transferable of the sd module at the given
 154         position.
 155         @param nInsertPosition
 156             The position at which to insert the pages.  The valid range is
 157             [0,n] (both inclusive) with n the number of pages in the
 158             document.
 159         @return
 160             The number of inserted pages is returned.
 161     */
 162     sal_Int32 PasteTransferable (sal_Int32 nInsertPosition);
 163
 164     /** Select a range of pages of the model.  Typicall usage is the
 165         selection of newly inserted pages.
 166         @param nFirstIndex
 167             The index of the first page to select.
 168         @param nPageCount
 169             The number of pages to select.
 170     */
 171     void SelectPageRange (sal_Int32 nFirstIndex, sal_Int32 nPageCount);
 172
 173     /** Return <TRUE/> when the current transferable in the current state of
 174         the slidesorter is acceptable to be pasted.  For this the
 175         transferable has to
 176         a) exist,
 177         b) contain one or more regular draw pages, no master pages.
 178         When master pages are involved, either in the transferable or in the
 179         slide sorter (by it displaying master pages) the drop of the
 180         transferable is not accepted.  The reason is the missing
 181         implementation of proper handling master pages copy-and-paste.
 182     */
 183     enum DropType { DT_PAGE, DT_SHAPE, DT_NONE };
 184     DropType IsDropAccepted (void) const;
 185
 186     /** This method contains the code for AcceptDrop() and ExecuteDrop() shapes.
 187         There are only minor differences for the two cases at this level.
 188         @param eCommand
 189             This parameter specifies whether to do a AcceptDrop() or
 190             ExecuteDrop().
 191         @param rPosition
 192             Since the event is given as void pointer we can not take the
 193             mouse position from it.  The caller has to supply it in this
 194             parameter.
 195         @param pDropEvent
 196             Event though the AcceptDropEvent and ExecuteDropEvent are very
 197             similar they do not have a common base class.  Because of that
 198             we have to use a void* to pase these structs.
 199         @param nPage
 200             When the page number is given as 0xffff then it is replaced by
 201             the number of the page at the mouse position.  If the mouse is
 202             not over a page then neither AcceptDrop() nor ExecuteDrop() are
 203             executed.
 204     */
 205     enum DropCommand { DC_ACCEPT, DC_EXECUTE };
 206     sal_Int8 ExecuteOrAcceptShapeDrop (
 207         DropCommand eCommand,
 208         const Point& rPosition,
 209         const void* pDropEvent ,
 210         DropTargetHelper& rTargetHelper,
 211         ::sd::Window* pTargetWindow,
 212         USHORT nPage,
 213         USHORT nLayer);
 214 };
 215
 216 } } } // end of namespace ::sd::slidesorter::controller
 217
 218 #endif
 219