xref: /AOO41X/main/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XClipboardFactory_idl__
25#define __com_sun_star_datatransfer_clipboard_XClipboardFactory_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_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 published interface XClipboard;
40
41//=============================================================================
42/** Should be implemented by a clipboard factory that simplifies the creation of
43    multiple clipboard instances.
44
45    @see com::sun::star::datatransfer::clipboard::XClipboard
46*/
47
48published interface XClipboardFactory: com::sun::star::uno::XInterface
49{
50    //-------------------------------------------------------------------------
51    /** Creates a new named clipboard instance.
52
53        @returns
54        A newly created instance of a <type>GenericClipboard</type>
55        implementation.
56
57        @param aName
58        The name the clipboard should have.
59
60        @throws com::sun::star::lang::IllegalArgumentException
61        If an empty string is passed as clipboard name.
62    */
63    XClipboard createClipboard( [in] string aName )
64        raises ( com::sun::star::lang::IllegalArgumentException );
65};
66
67//=============================================================================
68
69}; }; }; }; };
70
71#endif
72