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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_datatransfer_XTransferableSupplier_idl__
  21 #define __com_sun_star_datatransfer_XTransferableSupplier_idl__
  22
  23 #include <com/sun/star/datatransfer/XTransferable.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27 module com { module sun { module star { module datatransfer {
  28
  29 interface XTransferableSupplier
  30 {
  31     /** To get access to a transferable representation of a selected part of an object.
  32
  33         @returns
  34         The transferable object representing the selection inside the supplying object
  35
  36         @see com::sun::star::datatransfer::XTransferable
  37     */
  38     XTransferable getTransferable();
  39
  40     /** Hands over a transferable object that shall be inserted.
  41
  42         @param xTrans
  43         The transferable object to be inserted
  44         <p>A NULL value is not allowed.</p>
  45
  46         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  47         if the given com::sun::star::datatransfer::XTransferable
  48         has no com::sun::star::datatransfer::DataFlavor or the called
  49         object can't handle any of the available ones.
  50
  51         @see com::sun::star::datatransfer::XTransferable
  52     */
  53     void insertTransferable( [in] XTransferable xTrans )
  54         raises ( UnsupportedFlavorException );
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */