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