offapi/com/sun/star/datatransfer/XTransferableSupplier.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: XTransferableSupplier.idl,v $
  10  * $Revision: 1.3 $
  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_XTransferableSupplier_idl__
  32 #define __com_sun_star_datatransfer_XTransferableSupplier_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  35 #include <com/sun/star/datatransfer/XTransferable.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 interface XTransferableSupplier
  47 {
  48     //-------------------------------------------------------------------------
  49     /** To get access to a transferable representation of a selected part of an object.
  50
  51         @returns
  52         The transferable object representing the selection inside the supplying object
  53
  54         @see com::sun::star::datatransfer::XTransferable
  55     */
  56     XTransferable getTransferable();
  57
  58     //-------------------------------------------------------------------------
  59     /** Hands over a transferable object that shall be inserted.
  60
  61         @param xTrans
  62         The transferable object to be inserted
  63         <p>A NULL value is not allowed.</p>
  64
  65         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  66         if the given <type scope="com::sun::star::datatransfer">XTransferable</type>
  67         has no <type scope="com::sun::star::datatransfer">DataFlavor</type> or the called
  68         object can't handle any of the available ones.
  69
  70         @see com::sun::star::datatransfer::XTransferable
  71     */
  72     void insertTransferable( [in] XTransferable xTrans )
  73         raises ( UnsupportedFlavorException );
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif