offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SystemClipboard.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_datatransfer_clipboard_SystemClipboard_idl__
  32 #define __com_sun_star_datatransfer_clipboard_SystemClipboard_idl__
  33
  34 #ifndef __com_sun_star_lang_XComponent_idl__
  35 #include <com/sun/star/lang/XComponent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  39 #include <com/sun/star/lang/XServiceInfo.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_XTypeProvider_idl__
  43 #include <com/sun/star/lang/XTypeProvider.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_lang_XInitialization_idl__
  47 #include <com/sun/star/lang/XInitialization.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module datatransfer { module clipboard {
  53
  54 //=============================================================================
  55
  56  published interface XClipboardEx;
  57  published interface XClipboardNotifier;
  58  published interface XFlushableClipboard;
  59
  60 //=============================================================================
  61 /** The system clipboard service builds a bridge to the OS specific clipboard
  62     interfaces.
  63
  64     <br/><br/><p><strong>Notes:</strong> The Unix implementation needs to be instantiated with 2 Arguments:
  65     <ul>
  66         <li>A <type scope="com::sun::star::awt">XDisplayConnection</type> that provides the
  67         display to be used.</li>
  68         <li>A string that names the selection to be used</li>
  69     </ul>
  70     It is possible to use clipboards for different selections simultaneously.</p>
  71 */
  72 published service SystemClipboard
  73 {
  74     //-------------------------------------------------------------------------
  75     /** Provides access to the clipboard content.
  76     */
  77     interface XClipboardEx;
  78
  79     //-------------------------------------------------------------------------
  80     /** Provides the ability to request notifications on content changes.
  81     */
  82     interface XClipboardNotifier;
  83
  84     //-------------------------------------------------------------------------
  85     /** Provides the ability to render the complete clipboard content. This
  86         interface is only available if the method
  87         <member scope="com::sun::star::datatransfer::clipboard">XClipboardEx::getRenderingCapabilities()</member>
  88         returns Persistant
  89     */
  90     [optional] interface XFlushableClipboard;
  91
  92     //-------------------------------------------------------------------------
  93     /** Provides the ability to initialize the clipboard
  94     */
  95     [optional] interface com::sun::star::lang::XInitialization;
  96
  97     //-------------------------------------------------------------------------
  98     /** For shutdown and listener support.
  99     */
 100     interface com::sun::star::lang::XComponent;
 101
 102     //-------------------------------------------------------------------------
 103     /** Service should always support this interface.
 104     */
 105     interface com::sun::star::lang::XServiceInfo;
 106
 107     //-------------------------------------------------------------------------
 108     /** Service should always support this interface.
 109     */
 110     interface com::sun::star::lang::XTypeProvider;
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; }; };
 116
 117 #endif