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_clipboard_XClipboard_idl__
29#define __com_sun_star_datatransfer_clipboard_XClipboard_idl__
30
31#ifndef __com_sun_star_datatransfer_XTransferable_idl__
32#include <com/sun/star/datatransfer/XTransferable.idl>
33#endif
34
35#ifndef __com_sun_star_uno_XInterface_idl__
36#include <com/sun/star/uno/XInterface.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module datatransfer { module clipboard {
42
43//=============================================================================
44/** The default interface to access clipboard instances.
45*/
46
47 published interface XClipboardListener;
48 published interface XClipboardOwner;
49
50published interface XClipboard: com::sun::star::uno::XInterface
51{
52	//-------------------------------------------------------------------------
53	/** To get the current content of the clipboard.
54
55		@returns
56		The transferable object representing the current content of
57		this clipboard.
58
59		@see com::sun::star::datatransfer::XTransferable
60	*/
61	XTransferable getContents();
62
63	//-------------------------------------------------------------------------
64	/** Sets the current contents of the clipboard to the specified
65		transferable object and registers the specified clipboard owner
66		as the owner of the new contents.
67
68		@param xTrans
69		The transferable object to set as new content.
70		<p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type>
71		has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard
72		will be deleted.
73		<p>A NULL value is not allowed.</p>
74
75		@param xClipboardOwner
76		The new owner of the clipboard.
77		<p>NULL is an acceptable value and means that the
78		caller is not interested in lost ownership notifications.</p>
79
80		@see com::sun::star::datatransfer::XTransferable
81		@see com::sun::star::datatransfer::clipboard::XClipboardOwner
82	*/
83	[oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );
84
85	//-------------------------------------------------------------------------
86	/** To get the name of the clipboard instance.
87
88		@returns
89		The name of this clipboard object.
90		<p>If the returned string is empty the
91		clipboard instance ist the system clipboard.</p>
92	*/
93	string getName();
94};
95
96//=============================================================================
97
98}; }; }; }; };
99
100#endif
101