offapi/com/sun/star/datatransfer/XDataFormatTranslator.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
  21 #ifndef __com_sun_star_datatransfer_XDataFormatTranslator_idl__
  22 #define __com_sun_star_datatransfer_XDataFormatTranslator_idl__
  23
  24 #include <com/sun/star/uno/XInterface.idl>
  25 #include <com/sun/star/datatransfer/DataFlavor.idl>
  26
  27 module com { module sun { module star { module datatransfer {
  28
  29 /** Interface to be implemented by objects used to translate a DataFlavor to
  30     a system dependent data transfer type and vice versa.
  31
  32     <p>Different platforms use different types to describe data formats available
  33     during data exchange operations like clipboard or drag&drop. Windows for instance
  34     uses integer values to describe an available clipboard or drag&drop format, Unix
  35     X11 uses so called Atoms etc.</p>
  36 */
  37
  38 published interface XDataFormatTranslator : com::sun::star::uno::XInterface
  39 {
  40     /** Converts a DataFlavor to system dependent data type.
  41
  42         @param aDataFlavor
  43         Describes the format for which a system dependent data types is requested.
  44
  45         @returns
  46         A system dependent data transfer type for the given DataFlavor
  47         if there is one available.
  48         <p>If the is no system dependent data type for a given DataFlavor
  49         the returned any is empty.</p>
  50     */
  51     any getSystemDataTypeFromDataFlavor( [in] DataFlavor aDataFlavor );
  52
  53     /** Converts a system dependent data type to a DataFlavor.
  54
  55         @param aSysDataType
  56         A system dependent data type. If aSysDataType is empty so is the returned DataFlavor.
  57
  58         @returns
  59         A DataFlavor for the given system dependent data transfer type.
  60         <p>If there is no appropriate mapping for a system dependent data type, the returned DataFlavor will be empty.</p>
  61     */
  62     DataFlavor getDataFlavorFromSystemDataType( [in] any aSysDataType );
  63 };
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */