offapi/com/sun/star/datatransfer/XTransferDataAccess.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: XTransferDataAccess.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_XTransferDataInfo_idl__
  32 #define __com_sun_star_datatransfer_XTransferDataInfo_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 /** This interface provides direct access to the data in all data flavors. It can
  48     be used by the clipboard implementation to optimize data transport on
  49     flush operations.
  50
  51     @see com::sun::star::datatransfer::XTransferable
  52 */
  53
  54 published interface XTransferDataAccess: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57     /** To query for the summarized data size in bytes of a sequence of <type>DataFlavor</type>.
  58
  59         @param aFlavorList
  60         A squence of requested <type>DataFlavor</type>.
  61         <p>An unsupported <type>DataFlavor</type> will be ignored.</p>
  62
  63         @returns
  64         The number of bytes of the transfer data in the specified sequence of <type>DataFlavor</type>.
  65     */
  66     hyper queryDataSize( [in] sequence < DataFlavor > aFlavorList );
  67
  68     //-------------------------------------------------------------------------
  69     /** To get all the data of a sequence of <type>DataFlavor</type>.
  70
  71         @param aFlavorList
  72         The sequence of requested <type>DataFlavor</type>.
  73         <p>An unsupported <type>DataFlavor</type> will be ignored.</p>
  74
  75         @returns
  76         The data in the requested <type>DataFlavor</type>.
  77         <p>For unsupported <type>DataFlavor</type> an
  78         empty any will be returned.</p>
  79      */
  80     sequence < any > getData( [in] sequence < DataFlavor > aFlavorList );
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif