offapi/com/sun/star/graphic/XGraphicProvider.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 module com { module sun { module star { module graphic
  21 {
  22
  23 /** This interface acts as the main interface to handle graphic
  24     content. It is used to load graphics, store graphics and
  25     to get information about unloaded graphics
  26   */
  27 published interface XGraphicProvider : ::com::sun::star::uno::XInterface
  28 {
  29     /** Calling this method returns a
  30         com::sun::star::beans::XPropertySet
  31         interface that gives access to the properties of the
  32         unloaded graphic
  33
  34         <p>In most cases, this method will be used to query the
  35         mime type of the graphic and, in the case of pixel graphics,
  36         the resulting size after loading</p>
  37
  38         @param MediaProperties
  39             A sequence of property values to describe the location
  40             of the graphic, for which the attributes should be returned
  41
  42         @returns
  43             A com::sun::star::beans::XPropertySet interface
  44             to get access to the different graphic properties
  45
  46         @see MediaProperties
  47         @see GraphicDescriptor
  48         @see com::sun::star::beans::PropertyValues
  49     */
  50     ::com::sun::star::beans::XPropertySet   queryGraphicDescriptor( [in] ::com::sun::star::beans::PropertyValues MediaProperties )
  51                                                 raises( ::com::sun::star::io::IOException,
  52                                                         ::com::sun::star::lang::IllegalArgumentException,
  53                                                         ::com::sun::star::lang::WrappedTargetException );
  54
  55
  56
  57     /** Calling this method returns a XGraphic interface
  58         that holds the graphic content after loading the graphic
  59
  60         @param MediaProperties
  61             A sequence of property values to describe the location
  62             of the graphic from which the graphic is to be loaded
  63
  64         @returns
  65             The XGraphic interface
  66
  67         @see MediaProperties
  68         @see XGraphic
  69         @see com::sun::star::beans::PropertyValues
  70     */
  71     XGraphic    queryGraphic( [in] ::com::sun::star::beans::PropertyValues MediaProperties )
  72                      raises( ::com::sun::star::io::IOException,
  73                               ::com::sun::star::lang::IllegalArgumentException,
  74                              ::com::sun::star::lang::WrappedTargetException );
  75
  76     /** Store the graphic content, represented through the XGraphic
  77         interface at the specified location
  78
  79         @param Graphic
  80             The graphic that should be stored
  81
  82         @param MediaProperties
  83             A sequence of property values to describe the destination
  84             location of the graphic
  85
  86         @see XGraphic
  87         @see MediaProperties
  88         @see com::sun::star::beans::PropertyValues
  89     */
  90     void        storeGraphic( [in] ::com::sun::star::graphic::XGraphic Graphic,
  91                               [in] ::com::sun::star::beans::PropertyValues MediaProperties  )
  92                     raises( ::com::sun::star::io::IOException,
  93                              ::com::sun::star::lang::IllegalArgumentException,
  94                             ::com::sun::star::lang::WrappedTargetException );
  95 };
  96
  97 } ; } ; } ; } ;
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */