offapi/com/sun/star/datatransfer/XTransferable2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   6  */
   7
   8 #ifndef __com_sun_star_datatransfer_XTransferable2_idl__
   9 #define __com_sun_star_datatransfer_XTransferable2_idl__
  10
  11 #include <com/sun/star/datatransfer/XTransferable.idl>
  12
  13 module com { module sun { module star { module datatransfer {
  14
  15 interface XTransferable2 : com::sun::star::datatransfer::XTransferable
  16 {
  17     /** This is equivalent of getTransferData of XTransferable, but takes an
  18         additional parameter that specifies the destination document type.
  19
  20         @param aFlavor requested data format
  21         @param aDestShellID destination document shell ID.  The ID of each
  22         individual shell must be unique.
  23
  24         @returns data in specified data format.
  25
  26         @throws com::sun::star::io::IOException
  27         if the data is no longer available in the requested flavor.
  28
  29         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  30         if the requested DataFlavor is not supported.
  31      */
  32     any getTransferData2( [in] DataFlavor aFlavor, [in] string aDestShellID )
  33         raises ( UnsupportedFlavorException, com::sun::star::io::IOException );
  34 };
  35
  36 }; }; }; };
  37
  38 #endif
  39
  40 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
  41