/*************************************************************************
 *
 *  $RCSfile: XClipboard.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:03:12 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_datatransfer_clipboard_XClipboard_idl__
#define __com_sun_star_datatransfer_clipboard_XClipboard_idl__

#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#include <com/sun/star/datatransfer/XTransferable.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

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

//=============================================================================
/** The default interface to access clipboard instances.
*/

interface XClipboardListener;
interface XClipboardOwner;

interface XClipboard: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** To get the current content of the clipboard.

        @returns
        The transferable object representing the current content of
        this clipboard.

        @see com::sun::star::datatransfer::XTransferable
    */
    XTransferable getContents();

    //-------------------------------------------------------------------------
    /** Sets the current contents of the clipboard to the specified 
        transferable object and registers the specified clipboard owner 
        as the owner of the new contents.

        @param xTrans
        The transferable object to set as new content.
        <p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type>
        has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard
        will be deleted.
        <p>A NULL value is not allowed.</p>

        @param xClipboardOwner
        The new owner of the clipboard. 
        <p>NULL is an acceptable value and means that the
        caller is not interested in lost ownership notifications.</p>
        
        @see com::sun::star::datatransfer::XTransferable
        @see com::sun::star::datatransfer::clipboard::XClipboardOwner
    */
    [oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );

    //-------------------------------------------------------------------------
    /** To get the name of the clipboard instance.
        
        @returns
        The name of this clipboard object. 
        <p>If the returned string is empty the 
        clipboard instance ist the system clipboard.</p>
    */
    string getName();
};

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

}; }; }; }; };

#endif