reportdesign/source/ui/inc/dlgedclip.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: dlgedclip.hxx,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef _REPORT_RPTUICLIP_HXX
  32 #define _REPORT_RPTUICLIP_HXX
  33
  34 #include <svtools/transfer.hxx>
  35 #include <com/sun/star/beans/NamedValue.hpp>
  36
  37 namespace rptui
  38 {
  39 //============================================================================
  40 // OReportExchange
  41 //============================================================================
  42 /** \class OReportExchange
  43  * \brief defines a clipboard fromat for copying selection elements.
  44  * \ingroup reportdesign_source_ui_report
  45  *
  46  *
  47  */
  48 class OReportExchange : public TransferableHelper
  49 {
  50 public:
  51     typedef ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > TSectionElements;
  52
  53     /** Constructs a new exchange object with section elements
  54     *
  55     * \param _rCopyElements the elements to copy. Each section is one entry. The value must be a sequence of elements.
  56     * \return
  57     */
  58     OReportExchange( const TSectionElements& _rCopyElements);
  59
  60     /** checks whether or not a descriptor can be extracted from the data flavor vector given
  61     *
  62     * \param _rFlavors
  63             available flavors
  64     * \return
  65     */
  66         static sal_Bool         canExtract(const DataFlavorExVector& _rFlavors);
  67
  68     /** extract the section elements
  69     *
  70     * \param _rData the clipboard data
  71     * \return the copied elements
  72     */
  73     static TSectionElements extractCopies(const TransferableDataHelper& _rData);
  74
  75     /** returns the format id.
  76     *
  77     * \return the registered format id
  78     */
  79     static sal_uInt32       getDescriptorFormatId();
  80
  81 protected:
  82         // TransferableHelper overridables
  83         virtual void            AddSupportedFormats();
  84         virtual sal_Bool        GetData( const ::com::sun::star::datatransfer::DataFlavor& rFlavor );
  85 private:
  86     TSectionElements    m_aCopyElements;
  87 };
  88 }
  89 #endif // _REPORT_RPTUICLIP_HXX