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_XClipboardManager_idl__
25#define __com_sun_star_datatransfer_clipboard_XClipboardManager_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30
31#ifndef __com_sun_star_container_ElementExistException_idl__
32#include <com/sun/star/container/ElementExistException.idl>
33#endif
34
35#ifndef __com_sun_star_container_NoSuchElementException_idl__
36#include <com/sun/star/container/NoSuchElementException.idl>
37#endif
38
39#ifndef __com_sun_star_uno_XInterface_idl__
40#include <com/sun/star/uno/XInterface.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module datatransfer { module clipboard {
46
47 published interface XClipboard;
48
49//=============================================================================
50/** This interface is used to retrieve, add, or remove clipboard instances.
51
52	@see com::sun::star::datatransfer::clipboard::XClipboard
53*/
54
55published interface XClipboardManager: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58	/** Get a clipboard instance by name.
59
60		@returns
61		The clipboard object with the specified name.
62
63		@param aName
64		The name of clipboard to return. To retrieve the default (system)
65		clipboard, pass an empty string.
66
67		@throws com::sun::star::container::NoSuchElementException
68		if no clipboard with the specified name exists.
69	*/
70    XClipboard getClipboard( [in] string aName )
71		raises ( com::sun::star::container::NoSuchElementException );
72
73	//-------------------------------------------------------------------------
74	/** Add a clipboard instance to the manager's list.
75
76		@param xClipboard
77		The clipboard to add.
78
79		@throws com::sun::star::IllegalArgumentException
80		if xClipboard is not a valid clipboard.
81
82		@throws com::sun::star::container::ElementExistsException
83		if a clipboard with the name of xClipboard already exists.
84    */
85    void addClipboard( [in] XClipboard xClipboard )
86		raises ( com::sun::star::lang::IllegalArgumentException,
87		         com::sun::star::container::ElementExistException );
88
89	//-------------------------------------------------------------------------
90	/** Removes the clipboard with the specified name from the list.
91
92		@param aName
93		The name of the clipboard to remove.
94    */
95    void removeClipboard( [in] string aName );
96
97	//-------------------------------------------------------------------------
98	/** Get a list of a managed clipboards.
99
100		@returns
101		A sequence of the names of all available clipboards.
102     */
103	sequence < string > listClipboardNames();
104};
105
106//=============================================================================
107
108}; }; }; }; };
109
110#endif
111