offapi/com/sun/star/datatransfer/XTransferable.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: XTransferable.idl,v $
  10  * $Revision: 1.12 $
  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_XTransferable_idl__
  32 #define __com_sun_star_datatransfer_XTransferable_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__
  35 #include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_datatransfer_DataFlavor_idl__
  39 #include <com/sun/star/datatransfer/DataFlavor.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_io_IOException_idl__
  43 #include <com/sun/star/io/IOException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_uno_XInterface_idl__
  47 #include <com/sun/star/uno/XInterface.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module datatransfer {
  53
  54 //=============================================================================
  55 /** Interface to be implemented by objects used to provide data for a data
  56     transfer operation.
  57
  58     @see com::sun::star::datatransfer::DataFlavor
  59 */
  60
  61 published interface XTransferable: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64     /** Called by a data consumer to obtain data from the source in a specified
  65         format.
  66
  67         @param aFlavor
  68         Describes the requested data format
  69
  70         @returns
  71         The data in the specified <type>DataFlavor</type>.
  72
  73         @throws com::sun::star::io::IOException
  74         if the data is no longer available in the requested flavor.
  75
  76         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  77         if the requested <type>DataFlavor</type> is not supported.
  78     */
  79     any getTransferData( [in] DataFlavor aFlavor )
  80         raises ( UnsupportedFlavorException, com::sun::star::io::IOException );
  81
  82     //-------------------------------------------------------------------------
  83     /** Returns a sequence of supported <type>DataFlavor</type>.
  84
  85         @returns
  86         The sequence of supported <type>DataFlavor</type>.
  87
  88         @see com::sun::star::datatransfer::DataFlavor
  89     */
  90     sequence < DataFlavor > getTransferDataFlavors();
  91
  92     //-------------------------------------------------------------------------
  93     /** Checks if the data object supports the specified data flavor.
  94
  95         @param aFlavor
  96         Describes the format that should be checked
  97
  98         @returns
  99         A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source.
 100         <p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p>
 101
 102         <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To
 103         avoid many calls, the caller should instead use
 104         <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>.
 105     */
 106     boolean isDataFlavorSupported( [in] DataFlavor aFlavor );
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif