offapi/com/sun/star/datatransfer/XTransferableEx.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: XTransferableEx.idl,v $
  10  * $Revision: 1.11 $
  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_XTransferableEx_idl__
  32 #define __com_sun_star_datatransfer_XTransferable_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_DataFlavor_idl__
  35 #include <com/sun/star/datatransfer/DataFlavor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module datatransfer {
  45
  46 //=============================================================================
  47 /** Interface to be implemented by objects used to provide data for a transfer
  48     operation.
  49
  50     @see com::sun::star::datatransfer::DataFlavor
  51     @see com::sun::star::datatransfer::XTransferable
  52 */
  53
  54
  55 published interface XTransferableEx: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** @param requestedFlavors
  59         Sequence of <type>DataFlavor</type> of interest. Specify an empty sequence for interest
  60         in all data flavors with top-level MIME content-types. To get all MIME
  61         content-types, call <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>.
  62
  63         @returns
  64         The list of the matching supported <type>DataFlavor</type> that were requested. For
  65         each requested top-level MIME content-type, all supported subtypes are returned.
  66     */
  67     sequence < DataFlavor > queryTransferDataFlavors( [in] sequence< DataFlavor > requestedFlavors );
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif