diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 16:51:28 +0000 |
commit | 940b4d1848e8c70ab7642901a68594e8016caffc (patch) | |
tree | eb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /offapi/com/sun/star/graphic/XGraphicProvider.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.tar.xz libreoffice-940b4d1848e8c70ab7642901a68594e8016caffc.zip |
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/graphic/XGraphicProvider.idl')
-rw-r--r-- | offapi/com/sun/star/graphic/XGraphicProvider.idl | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/offapi/com/sun/star/graphic/XGraphicProvider.idl b/offapi/com/sun/star/graphic/XGraphicProvider.idl new file mode 100644 index 000000000..ae13e3d11 --- /dev/null +++ b/offapi/com/sun/star/graphic/XGraphicProvider.idl @@ -0,0 +1,113 @@ +/* -*- 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_graphic_XGraphicProvider_idl +#define com_sun_star_graphic_XGraphicProvider_idl + +#include <com/sun/star/io/XInputStream.idl> +#include <com/sun/star/io/XOutputStream.idl> +#include <com/sun/star/io/IOException.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/lang/WrappedTargetException.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module graphic +{ + +/** This interface acts as the main interface to handle graphic + content. It is used to load graphics, store graphics and + to get information about unloaded graphics + */ +published interface XGraphicProvider : ::com::sun::star::uno::XInterface +{ + /** Calling this method returns a + com::sun::star::beans::XPropertySet + interface that gives access to the properties of the + unloaded graphic + + <p>In most cases, this method will be used to query the + mime type of the graphic and, in the case of pixel graphics, + the resulting size after loading</p> + + @param MediaProperties + A sequence of property values to describe the location + of the graphic, for which the attributes should be returned + + @returns + A com::sun::star::beans::XPropertySet interface + to get access to the different graphic properties + + @see MediaProperties + @see GraphicDescriptor + @see com::sun::star::beans::PropertyValues + */ + ::com::sun::star::beans::XPropertySet queryGraphicDescriptor( [in] ::com::sun::star::beans::PropertyValues MediaProperties ) + raises( ::com::sun::star::io::IOException, + ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::lang::WrappedTargetException ); + + + + /** Calling this method returns a XGraphic interface + that holds the graphic content after loading the graphic + + @param MediaProperties + A sequence of property values to describe the location + of the graphic from which the graphic is to be loaded + + @returns + The XGraphic interface + + @see MediaProperties + @see XGraphic + @see com::sun::star::beans::PropertyValues + */ + XGraphic queryGraphic( [in] ::com::sun::star::beans::PropertyValues MediaProperties ) + raises( ::com::sun::star::io::IOException, + ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::lang::WrappedTargetException ); + + /** Store the graphic content, represented through the XGraphic + interface at the specified location + + @param Graphic + The graphic that should be stored + + @param MediaProperties + A sequence of property values to describe the destination + location of the graphic + + @see XGraphic + @see MediaProperties + @see com::sun::star::beans::PropertyValues + */ + void storeGraphic( [in] ::com::sun::star::graphic::XGraphic Graphic, + [in] ::com::sun::star::beans::PropertyValues MediaProperties ) + raises( ::com::sun::star::io::IOException, + ::com::sun::star::lang::IllegalArgumentException, + ::com::sun::star::lang::WrappedTargetException ); +}; + +} ; } ; } ; } ; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |