offapi/com/sun/star/datatransfer/XTransferDataAccess.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_XTransferDataAccess_idl__
  21 #define __com_sun_star_datatransfer_XTransferDataAccess_idl__
  22
  23 #include <com/sun/star/datatransfer/DataFlavor.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26
  27 module com { module sun { module star { module datatransfer {
  28
  29 /** This interface provides direct access to the data in all data flavors. It can
  30     be used by the clipboard implementation to optimize data transport on
  31     flush operations.
  32
  33     @see com::sun::star::datatransfer::XTransferable
  34 */
  35
  36 published interface XTransferDataAccess: com::sun::star::uno::XInterface
  37 {
  38     /** To query for the summarized data size in bytes of a sequence of DataFlavor.
  39
  40         @param aFlavorList
  41         A sequence of requested DataFlavor.
  42         <p>An unsupported DataFlavor will be ignored.</p>
  43
  44         @returns
  45         The number of bytes of the transfer data in the specified sequence of DataFlavor.
  46     */
  47     hyper queryDataSize( [in] sequence < DataFlavor > aFlavorList );
  48
  49     /** To get all the data of a sequence of DataFlavor.
  50
  51         @param aFlavorList
  52         The sequence of requested DataFlavor.
  53         <p>An unsupported DataFlavor will be ignored.</p>
  54
  55         @returns
  56         The data in the requested DataFlavor.
  57         <p>For unsupported DataFlavor an
  58         empty any will be returned.</p>
  59      */
  60     sequence < any > getData( [in] sequence < DataFlavor > aFlavorList );
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */