xref: /aoo4110/main/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_datatransfer_clipboard_SystemClipboard_idl__
#define __com_sun_star_datatransfer_clipboard_SystemClipboard_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_lang_XServiceInfo_idl__
#include <com/sun/star/lang/XServiceInfo.idl>
#endif

#ifndef __com_sun_star_lang_XTypeProvider_idl__
#include <com/sun/star/lang/XTypeProvider.idl>
#endif

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif

//=============================================================================

module com { module sun { module star { module datatransfer { module clipboard {

//=============================================================================

 published interface XClipboardEx;
 published interface XClipboardNotifier;
 published interface XFlushableClipboard;

//=============================================================================
/** The system clipboard service builds a bridge to the OS specific clipboard
	interfaces.

    <br/><br/><p><strong>Notes:</strong> The Unix implementation needs to be instantiated with 2 Arguments:
    <ul>
    	<li>A <type scope="com::sun::star::awt">XDisplayConnection</type> that provides the
        display to be used.</li>
        <li>A string that names the selection to be used</li>
    </ul>
    It is possible to use clipboards for different selections simultaneously.</p>
*/
published service SystemClipboard
{
	//-------------------------------------------------------------------------
	/** Provides access to the clipboard content.
	*/
	interface XClipboardEx;

	//-------------------------------------------------------------------------
	/** Provides the ability to request notifications on content changes.
	*/
	interface XClipboardNotifier;

	//-------------------------------------------------------------------------
	/** Provides the ability to render the complete clipboard content. This
		interface is only available if the method
		<member scope="com::sun::star::datatransfer::clipboard">XClipboardEx::getRenderingCapabilities()</member>
		returns Persistant
	*/
	[optional] interface XFlushableClipboard;

	//-------------------------------------------------------------------------
	/** Provides the ability to initialize the clipboard
	*/
	[optional] interface com::sun::star::lang::XInitialization;

	//-------------------------------------------------------------------------
	/** For shutdown and listener support.
	*/
	interface com::sun::star::lang::XComponent;

	//-------------------------------------------------------------------------
	/** Service should always support this interface.
	*/
	interface com::sun::star::lang::XServiceInfo;

	//-------------------------------------------------------------------------
	/** Service should always support this interface.
	*/
	interface com::sun::star::lang::XTypeProvider;
};

//=============================================================================

}; }; }; }; };

#endif