blob: 3efb5bf90a4fbcc5f1ddbc3d50e3a0870a859271 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XTransferable.idl,v $
* $Revision: 1.12 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#define __com_sun_star_datatransfer_XTransferable_idl__
#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__
#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
#endif
#ifndef __com_sun_star_datatransfer_DataFlavor_idl__
#include <com/sun/star/datatransfer/DataFlavor.idl>
#endif
#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
//=============================================================================
module com { module sun { module star { module datatransfer {
//=============================================================================
/** Interface to be implemented by objects used to provide data for a data
transfer operation.
@see com::sun::star::datatransfer::DataFlavor
*/
published interface XTransferable: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** Called by a data consumer to obtain data from the source in a specified
format.
@param aFlavor
Describes the requested data format
@returns
The data in the specified <type>DataFlavor</type>.
@throws com::sun::star::io::IOException
if the data is no longer available in the requested flavor.
@throws com::sun::star::datatransfer::UnsupportedFlavorException
if the requested <type>DataFlavor</type> is not supported.
*/
any getTransferData( [in] DataFlavor aFlavor )
raises ( UnsupportedFlavorException, com::sun::star::io::IOException );
//-------------------------------------------------------------------------
/** Returns a sequence of supported <type>DataFlavor</type>.
@returns
The sequence of supported <type>DataFlavor</type>.
@see com::sun::star::datatransfer::DataFlavor
*/
sequence < DataFlavor > getTransferDataFlavors();
//-------------------------------------------------------------------------
/** Checks if the data object supports the specified data flavor.
@param aFlavor
Describes the format that should be checked
@returns
A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source.
<p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p>
<br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To
avoid many calls, the caller should instead use
<member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>.
*/
boolean isDataFlavorSupported( [in] DataFlavor aFlavor );
};
//=============================================================================
}; }; }; };
#endif
|
