sd/source/ui/inc/ViewClipboard.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/types.h>
  23
  24 class SdPage;
  25 class SdTransferable;
  26
  27 namespace sd
  28 {
  29 class View;
  30
  31 /** Handle clipboard related tasks for the draw view.
  32 */
  33 class ViewClipboard
  34 {
  35     ::sd::View& mrView;
  36
  37 public:
  38     ViewClipboard(::sd::View& rView);
  39     virtual ~ViewClipboard();
  40
  41     /** Handle the drop of a drag-and-drop action where the transferable
  42         contains a set of pages.
  43     */
  44     void HandlePageDrop(const SdTransferable& rTransferable);
  45
  46 protected:
  47     /** Return the first master page of the given transferable.  When the
  48         bookmark list of the transferable contains at least one non-master
  49         page then NULL is returned.
  50     */
  51     static SdPage* GetFirstMasterPage(const SdTransferable& rTransferable);
  52
  53     /** Assign the (first) master page of the given transferable to the
  54         (...) slide.
  55     */
  56     void AssignMasterPage(const SdTransferable& rTransferable, SdPage const* pMasterPage);
  57
  58     /** Return an index of a page after which the pages of the transferable
  59         are to be inserted into the target document.
  60     */
  61     virtual sal_uInt16 DetermineInsertPosition();
  62
  63     /** Insert the slides in the given transferable behind the last selected
  64         slide or, when the selection is empty, behind the last slide.
  65         @param rTransferable
  66             This transferable defines which pages to insert.
  67         @param nInsertPosition
  68             The pages of the transferable will be inserted behind the page
  69             with this index.
  70         @return
  71             Returns the number of inserted slides.
  72     */
  73     sal_uInt16 InsertSlides(const SdTransferable& rTransferable, sal_uInt16 nInsertPosition);
  74 };
  75
  76 } // end of namespace ::sd
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */