AOO410/main/offapi/com/sun/star/datatransfer/XTransferableSupplier.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_datatransfer_XTransferableSupplier_idl__
#define __com_sun_star_datatransfer_XTransferableSupplier_idl__

#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#include <com/sun/star/datatransfer/XTransferable.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module datatransfer {

published interface XTransferableSupplier
{
    //-------------------------------------------------------------------------
    /** To get access to a transferable representation of a selected part of an object.

        @returns
        The transferable object representing the selection inside the supplying object

        @see com::sun::star::datatransfer::XTransferable
    */
    XTransferable getTransferable();

    //-------------------------------------------------------------------------
    /** Hands over a transferable object that shall be inserted.

        @param xTrans
        The transferable object to be inserted
        <p>A NULL value is not allowed.</p>

        @throws com::sun::star::datatransfer::UnsupportedFlavorException
        if the given <type scope="com::sun::star::datatransfer">XTransferable</type>
        has no <type scope="com::sun::star::datatransfer">DataFlavor</type> or the called
        object can't handle any of the available ones.

        @see com::sun::star::datatransfer::XTransferable
    */
    void insertTransferable( [in] XTransferable xTrans )
        raises ( UnsupportedFlavorException );
};

//=============================================================================

}; }; }; };

#endif