offapi/com/sun/star/datatransfer/XTransferable.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_XTransferable_idl__
  21 #define __com_sun_star_datatransfer_XTransferable_idl__
  22
  23 #include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
  24 #include <com/sun/star/datatransfer/DataFlavor.idl>
  25 #include <com/sun/star/io/IOException.idl>
  26 #include <com/sun/star/uno/XInterface.idl>
  27
  28
  29 module com { module sun { module star { module datatransfer {
  30
  31 /** Interface to be implemented by objects used to provide data for a data
  32     transfer operation.
  33
  34     @see com::sun::star::datatransfer::DataFlavor
  35 */
  36
  37 published interface XTransferable: com::sun::star::uno::XInterface
  38 {
  39     /** Called by a data consumer to obtain data from the source in a specified
  40         format.
  41
  42         @param aFlavor
  43         Describes the requested data format
  44
  45         @returns
  46         The data in the specified DataFlavor.
  47
  48         @throws com::sun::star::io::IOException
  49         if the data is no longer available in the requested flavor.
  50
  51         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  52         if the requested DataFlavor is not supported.
  53     */
  54     any getTransferData( [in] DataFlavor aFlavor )
  55         raises ( UnsupportedFlavorException, com::sun::star::io::IOException );
  56
  57     /** Returns a sequence of supported DataFlavor.
  58
  59         @returns
  60         The sequence of supported DataFlavor.
  61
  62         @see com::sun::star::datatransfer::DataFlavor
  63     */
  64     sequence < DataFlavor > getTransferDataFlavors();
  65
  66     /** Checks if the data object supports the specified data flavor.
  67
  68         @param aFlavor
  69         Describes the format that should be checked
  70
  71         @returns
  72         A value of `TRUE` if the DataFlavor is supported by the transfer source.
  73         <p>A value of `FALSE` if the DataFlavor is unsupported by the transfer source.</p>
  74
  75         <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To
  76         avoid many calls, the caller should instead use
  77         com::sun::star::datatransfer::XTransferable::getTransferDataFlavors().
  78     */
  79     boolean isDataFlavorSupported( [in] DataFlavor aFlavor );
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */