1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_XTransferable_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_datatransfer_XTransferable_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_DataFlavor_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/datatransfer/DataFlavor.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_IOException_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/io/IOException.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module datatransfer { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski/** Interface to be implemented by objects used to provide data for a data 49*b1cdbd2cSJim Jagielski transfer operation. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::DataFlavor 52*b1cdbd2cSJim Jagielski*/ 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielskipublished interface XTransferable: com::sun::star::uno::XInterface 55*b1cdbd2cSJim Jagielski{ 56*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 57*b1cdbd2cSJim Jagielski /** Called by a data consumer to obtain data from the source in a specified 58*b1cdbd2cSJim Jagielski format. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param aFlavor 61*b1cdbd2cSJim Jagielski Describes the requested data format 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @returns 64*b1cdbd2cSJim Jagielski The data in the specified <type>DataFlavor</type>. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @throws com::sun::star::io::IOException 67*b1cdbd2cSJim Jagielski if the data is no longer available in the requested flavor. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @throws com::sun::star::datatransfer::UnsupportedFlavorException 70*b1cdbd2cSJim Jagielski if the requested <type>DataFlavor</type> is not supported. 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski any getTransferData( [in] DataFlavor aFlavor ) 73*b1cdbd2cSJim Jagielski raises ( UnsupportedFlavorException, com::sun::star::io::IOException ); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 76*b1cdbd2cSJim Jagielski /** Returns a sequence of supported <type>DataFlavor</type>. 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @returns 79*b1cdbd2cSJim Jagielski The sequence of supported <type>DataFlavor</type>. 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::DataFlavor 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski sequence < DataFlavor > getTransferDataFlavors(); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 86*b1cdbd2cSJim Jagielski /** Checks if the data object supports the specified data flavor. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski @param aFlavor 89*b1cdbd2cSJim Jagielski Describes the format that should be checked 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @returns 92*b1cdbd2cSJim Jagielski A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source. 93*b1cdbd2cSJim Jagielski <p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p> 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To 96*b1cdbd2cSJim Jagielski avoid many calls, the caller should instead use 97*b1cdbd2cSJim Jagielski <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski boolean isDataFlavorSupported( [in] DataFlavor aFlavor ); 100*b1cdbd2cSJim Jagielski}; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski//============================================================================= 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski}; }; }; }; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski#endif 107