1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_datatransfer_clipboard_XClipboard_idl__
25#define __com_sun_star_datatransfer_clipboard_XClipboard_idl__
26
27#ifndef __com_sun_star_datatransfer_XTransferable_idl__
28#include <com/sun/star/datatransfer/XTransferable.idl>
29#endif
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 { module clipboard {
38
39//=============================================================================
40/** The default interface to access clipboard instances.
41*/
42
43 published interface XClipboardListener;
44 published interface XClipboardOwner;
45
46published interface XClipboard: com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49	/** To get the current content of the clipboard.
50
51		@returns
52		The transferable object representing the current content of
53		this clipboard.
54
55		@see com::sun::star::datatransfer::XTransferable
56	*/
57	XTransferable getContents();
58
59	//-------------------------------------------------------------------------
60	/** Sets the current contents of the clipboard to the specified
61		transferable object and registers the specified clipboard owner
62		as the owner of the new contents.
63
64		@param xTrans
65		The transferable object to set as new content.
66		<p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type>
67		has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard
68		will be deleted.
69		<p>A NULL value is not allowed.</p>
70
71		@param xClipboardOwner
72		The new owner of the clipboard.
73		<p>NULL is an acceptable value and means that the
74		caller is not interested in lost ownership notifications.</p>
75
76		@see com::sun::star::datatransfer::XTransferable
77		@see com::sun::star::datatransfer::clipboard::XClipboardOwner
78	*/
79	[oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );
80
81	//-------------------------------------------------------------------------
82	/** To get the name of the clipboard instance.
83
84		@returns
85		The name of this clipboard object.
86		<p>If the returned string is empty the
87		clipboard instance ist the system clipboard.</p>
88	*/
89	string getName();
90};
91
92//=============================================================================
93
94}; }; }; }; };
95
96#endif
97