reportdesign/source/ui/inc/dlgedclip.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 #ifndef INCLUDED_REPORTDESIGN_SOURCE_UI_INC_DLGEDCLIP_HXX
  21 #define INCLUDED_REPORTDESIGN_SOURCE_UI_INC_DLGEDCLIP_HXX
  22
  23 #include <vcl/transfer.hxx>
  24 #include <com/sun/star/beans/NamedValue.hpp>
  25
  26 namespace rptui
  27 {
  28
  29 // OReportExchange
  30
  31 /** \class OReportExchange
  32  * \brief defines a clipboard format for copying selection elements.
  33  * \ingroup reportdesign_source_ui_report
  34  *
  35  *
  36  */
  37 class OReportExchange : public TransferableHelper
  38 {
  39 public:
  40     typedef css::uno::Sequence< css::beans::NamedValue > TSectionElements;
  41
  42     /** Constructs a new exchange object with section elements
  43     *
  44     * \param _rCopyElements the elements to copy. Each section is one entry. The value must be a sequence of elements.
  45     * \return
  46     */
  47     OReportExchange( const TSectionElements& _rCopyElements);
  48
  49     /** checks whether or not a descriptor can be extracted from the data flavor vector given
  50     *
  51     * \param _rFlavors
  52             available flavors
  53     * \return
  54     */
  55     static bool         canExtract(const DataFlavorExVector& _rFlavors);
  56
  57     /** extract the section elements
  58     *
  59     * \param _rData the clipboard data
  60     * \return the copied elements
  61     */
  62     static TSectionElements extractCopies(const TransferableDataHelper& _rData);
  63
  64     /** returns the format id.
  65     *
  66     * \return the registered format id
  67     */
  68     static SotClipboardFormatId getDescriptorFormatId();
  69
  70 protected:
  71     // TransferableHelper overridables
  72     virtual void        AddSupportedFormats() override;
  73     virtual bool GetData( const css::datatransfer::DataFlavor& rFlavor, const OUString& rDestDoc ) override;
  74 private:
  75     TSectionElements const m_aCopyElements;
  76 };
  77 }
  78 #endif // INCLUDED_REPORTDESIGN_SOURCE_UI_INC_DLGEDCLIP_HXX
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */