1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_datatransfer_XSystemTransferable_idl__
29#define __com_sun_star_datatransfer_XSystemTransferable_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module datatransfer {
38
39//=============================================================================
40/** Interface to be implemented by  objects used to provide system dependent data
41	for a transfer operation. Those objects usually also implement <type>XTransferable</type>.
42*/
43
44published interface XSystemTransferable: com::sun::star::uno::XInterface
45{
46	//-------------------------------------------------------------------------
47	/** Called by a data consumer to obtain a system specific data object from the
48		source.
49		The data object is returned in an any. The contained type may differ on
50		different platforms.
51
52		@param aProcessId
53		The argument aProcessId is a process identifier of the caller's process.
54		The interface implementation must ensure that the system data object can be
55		used in that process. If the data object is not valid in the caller process
56		then the returned any must be empty.
57
58		@returns
59		The system dependent data object.
60
61		<br/><br/><p><strong>Notes:</strong>Under Windows the returned any contains an unsigned long which represents a pointer to
62		an IDataObject interface. The caller of getData has to release the data
63		object (IDataObject::Release) if it is no longer needed.
64		The caller must also make sure that the current thread has been initialized for
65		OLE (use OleInitialize).</p>
66	*/
67	any getData( [in] sequence < byte > aProcessId);
68};
69
70}; }; }; };
71
72#endif
73