/*************************************************************************
 *
 *  $RCSfile: XTransferable.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:03:00 $
 *
 *  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_XTransferable_idl__
#define __com_sun_star_datatransfer_XTransferable_idl__

#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__
#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
#endif

#ifndef __com_sun_star_datatransfer_DataFlavor_idl__
#include <com/sun/star/datatransfer/DataFlavor.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.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 {

//=============================================================================
/** Interface to be implemented by objects used to provide data for a data 
	transfer operation.

    @see com::sun::star::datatransfer::DataFlavor
*/

interface XTransferable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** Called by a data consumer to obtain data from the source in a specified 
		format.
		
		@param aFlavor
		Describes the requested data format 

		@returns
		The data in the specified <type>DataFlavor</type>.

		@throws com::sun::star::io::IOException 
		if the data is no longer available in the requested flavor.
			
		@throws com::sun::star::datatransfer::UnsupportedFlavorException
		if the requested <type>DataFlavor</type> is not supported.		
	*/
	any getTransferData( [in] DataFlavor aFlavor )
		raises ( UnsupportedFlavorException, com::sun::star::io::IOException );

	//-------------------------------------------------------------------------
	/** Returns a sequence of supported <type>DataFlavor</type>.

		@returns
		The sequence of supported <type>DataFlavor</type>.

		@see com::sun::star::datatransfer::DataFlavor
	*/
	sequence < DataFlavor > getTransferDataFlavors();

	//-------------------------------------------------------------------------
	/** Checks if the data object supports the specified data flavor.

		@param aFlavor 
		Describes the format that should be checked

		@returns
		A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source.
		<p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p>
		
		<br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To
		avoid many calls, the caller should instead use 
		<member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>.		
	*/
	boolean isDataFlavorSupported( [in] DataFlavor aFlavor );
};

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

}; }; }; }; 

#endif
