xref: /AOO41X/main/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.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_SystemClipboard_idl__
25#define __com_sun_star_datatransfer_clipboard_SystemClipboard_idl__
26
27#ifndef __com_sun_star_lang_XComponent_idl__
28#include <com/sun/star/lang/XComponent.idl>
29#endif
30
31#ifndef __com_sun_star_lang_XServiceInfo_idl__
32#include <com/sun/star/lang/XServiceInfo.idl>
33#endif
34
35#ifndef __com_sun_star_lang_XTypeProvider_idl__
36#include <com/sun/star/lang/XTypeProvider.idl>
37#endif
38
39#ifndef __com_sun_star_lang_XInitialization_idl__
40#include <com/sun/star/lang/XInitialization.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module datatransfer { module clipboard {
46
47//=============================================================================
48
49 published interface XClipboardEx;
50 published interface XClipboardNotifier;
51 published interface XFlushableClipboard;
52
53//=============================================================================
54/** The system clipboard service builds a bridge to the OS specific clipboard
55    interfaces.
56
57    <br/><br/><p><strong>Notes:</strong> The Unix implementation needs to be instantiated with 2 Arguments:
58    <ul>
59        <li>A <type scope="com::sun::star::awt">XDisplayConnection</type> that provides the
60        display to be used.</li>
61        <li>A string that names the selection to be used</li>
62    </ul>
63    It is possible to use clipboards for different selections simultaneously.</p>
64*/
65published service SystemClipboard
66{
67    //-------------------------------------------------------------------------
68    /** Provides access to the clipboard content.
69    */
70    interface XClipboardEx;
71
72    //-------------------------------------------------------------------------
73    /** Provides the ability to request notifications on content changes.
74    */
75    interface XClipboardNotifier;
76
77    //-------------------------------------------------------------------------
78    /** Provides the ability to render the complete clipboard content. This
79        interface is only available if the method
80        <member scope="com::sun::star::datatransfer::clipboard">XClipboardEx::getRenderingCapabilities()</member>
81        returns Persistant
82    */
83    [optional] interface XFlushableClipboard;
84
85    //-------------------------------------------------------------------------
86    /** Provides the ability to initialize the clipboard
87    */
88    [optional] interface com::sun::star::lang::XInitialization;
89
90    //-------------------------------------------------------------------------
91    /** For shutdown and listener support.
92    */
93    interface com::sun::star::lang::XComponent;
94
95    //-------------------------------------------------------------------------
96    /** Service should always support this interface.
97    */
98    interface com::sun::star::lang::XServiceInfo;
99
100    //-------------------------------------------------------------------------
101    /** Service should always support this interface.
102    */
103    interface com::sun::star::lang::XTypeProvider;
104};
105
106//=============================================================================
107
108}; }; }; }; };
109
110#endif
111