1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _REPORT_RPTUICLIP_HXX
29*cdf0e10cSrcweir #define _REPORT_RPTUICLIP_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <svtools/transfer.hxx>
32*cdf0e10cSrcweir #include <com/sun/star/beans/NamedValue.hpp>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir namespace rptui
35*cdf0e10cSrcweir {
36*cdf0e10cSrcweir //============================================================================
37*cdf0e10cSrcweir // OReportExchange
38*cdf0e10cSrcweir //============================================================================
39*cdf0e10cSrcweir /** \class OReportExchange
40*cdf0e10cSrcweir  * \brief defines a clipboard fromat for copying selection elements.
41*cdf0e10cSrcweir  * \ingroup reportdesign_source_ui_report
42*cdf0e10cSrcweir  *
43*cdf0e10cSrcweir  *
44*cdf0e10cSrcweir  */
45*cdf0e10cSrcweir class OReportExchange : public TransferableHelper
46*cdf0e10cSrcweir {
47*cdf0e10cSrcweir public:
48*cdf0e10cSrcweir     typedef ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > TSectionElements;
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir     /** Constructs a new exchange object with section elements
51*cdf0e10cSrcweir     *
52*cdf0e10cSrcweir     * \param _rCopyElements the elements to copy. Each section is one entry. The value must be a sequence of elements.
53*cdf0e10cSrcweir     * \return
54*cdf0e10cSrcweir     */
55*cdf0e10cSrcweir     OReportExchange( const TSectionElements& _rCopyElements);
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir     /** checks whether or not a descriptor can be extracted from the data flavor vector given
58*cdf0e10cSrcweir     *
59*cdf0e10cSrcweir     * \param _rFlavors
60*cdf0e10cSrcweir             available flavors
61*cdf0e10cSrcweir     * \return
62*cdf0e10cSrcweir     */
63*cdf0e10cSrcweir 	static sal_Bool         canExtract(const DataFlavorExVector& _rFlavors);
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir     /** extract the section elements
66*cdf0e10cSrcweir     *
67*cdf0e10cSrcweir     * \param _rData the clipboard data
68*cdf0e10cSrcweir     * \return the copied elements
69*cdf0e10cSrcweir     */
70*cdf0e10cSrcweir     static TSectionElements extractCopies(const TransferableDataHelper& _rData);
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir     /** returns the format id.
73*cdf0e10cSrcweir     *
74*cdf0e10cSrcweir     * \return the registered format id
75*cdf0e10cSrcweir     */
76*cdf0e10cSrcweir     static sal_uInt32	    getDescriptorFormatId();
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir protected:
79*cdf0e10cSrcweir 	// TransferableHelper overridables
80*cdf0e10cSrcweir 	virtual void		AddSupportedFormats();
81*cdf0e10cSrcweir 	virtual sal_Bool	GetData( const ::com::sun::star::datatransfer::DataFlavor& rFlavor );
82*cdf0e10cSrcweir private:
83*cdf0e10cSrcweir     TSectionElements	m_aCopyElements;
84*cdf0e10cSrcweir };
85*cdf0e10cSrcweir }
86*cdf0e10cSrcweir #endif // _REPORT_RPTUICLIP_HXX
87