diff options
Diffstat (limited to 'offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl')
-rw-r--r-- | offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl new file mode 100644 index 000000000..6e0cbc1d6 --- /dev/null +++ b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl @@ -0,0 +1,69 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + + +#ifndef __com_sun_star_datatransfer_XDataFormatTranslator_idl__ +#define __com_sun_star_datatransfer_XDataFormatTranslator_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/datatransfer/DataFlavor.idl> + +module com { module sun { module star { module datatransfer { + +/** Interface to be implemented by objects used to translate a DataFlavor to + a system dependent data transfer type and vice versa. + + <p>Different platforms use different types to describe data formats available + during data exchange operations like clipboard or drag&drop. Windows for instance + uses integer values to describe an available clipboard or drag&drop format, Unix + X11 uses so called Atoms etc.</p> +*/ + +published interface XDataFormatTranslator : com::sun::star::uno::XInterface +{ + /** Converts a DataFlavor to system dependent data type. + + @param aDataFlavor + Describes the format for which a system dependent data types is requested. + + @returns + A system dependent data transfer type for the given DataFlavor + if there is one available. + <p>If the is no system dependent data type for a given DataFlavor + the returned any is empty.</p> + */ + any getSystemDataTypeFromDataFlavor( [in] DataFlavor aDataFlavor ); + + /** Converts a system dependent data type to a DataFlavor. + + @param aSysDataType + A system dependent data type. If aSysDataType is empty so is the returned DataFlavor. + + @returns + A DataFlavor for the given system dependent data transfer type. + <p>If there is no appropriate mapping for a system dependent data type, the returned DataFlavor will be empty.</p> + */ + DataFlavor getDataFlavorFromSystemDataType( [in] any aSysDataType ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |