offapi/com/sun/star/graphic/XGraphicProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XGraphicProvider.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef com_sun_star_graphic_XGraphicProvider_idl
  32 #define com_sun_star_graphic_XGraphicProvider_idl
  33
  34 #include <com/sun/star/io/XInputStream.idl>
  35 #include <com/sun/star/io/XOutputStream.idl>
  36 #include <com/sun/star/io/IOException.idl>
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #include <com/sun/star/lang/WrappedTargetException.idl>
  39 #include <com/sun/star/beans/PropertyValues.idl>
  40 #include <com/sun/star/beans/XPropertySet.idl>
  41 #include <com/sun/star/graphic/XGraphic.idl>
  42
  43 module com { module sun { module star { module graphic
  44 {
  45
  46 /** This interface acts as the main interface to handle graphic
  47     content. It is used to load graphics, store graphics and
  48     to get information about unloaded graphics
  49   */
  50 published interface XGraphicProvider : ::com::sun::star::uno::XInterface
  51 {
  52     /** Calling this method returns a
  53         <type scope="com::sun::star::beans">XPropertySet</type>
  54         interface that gives access to the properties of the
  55         unloaded graphic
  56
  57         <p>In most cases, this method will be used to query the
  58         mime type of the graphic and, in the case of pixel graphics,
  59         the resulting size after loading</p>
  60
  61         @param MediaProperties
  62             A sequence of property values to describe the location
  63             of the graphic, for which the attributes should be returned
  64
  65         @returns
  66             A <type scope="com::sun::star::beans">XPropertySet</type> interface
  67             to get access to the different graphic properties
  68
  69         @see MediaProperties
  70         @see GraphicDescriptor
  71         @see com::sun::star::beans::PropertyValues
  72     */
  73     ::com::sun::star::beans::XPropertySet       queryGraphicDescriptor( [in] ::com::sun::star::beans::PropertyValues MediaProperties )
  74                                                 raises( ::com::sun::star::io::IOException,
  75                                                         ::com::sun::star::lang::IllegalArgumentException,
  76                                                         ::com::sun::star::lang::WrappedTargetException );
  77
  78
  79
  80     /** Calling this method returns a <type>XGraphic</type> interface
  81         that holds the graphic content after loading the graphic
  82
  83         @param MediaProperties
  84             A sequence of property values to describe the location
  85             of the graphic from which the graphic is to be loaded
  86
  87         @returns
  88             The <type>XGraphic</type> interface
  89
  90         @see MediaProperties
  91         @see XGraphic
  92         @see com::sun::star::beans::PropertyValues
  93     */
  94     XGraphic    queryGraphic( [in] ::com::sun::star::beans::PropertyValues MediaProperties )
  95                      raises( ::com::sun::star::io::IOException,
  96                               ::com::sun::star::lang::IllegalArgumentException,
  97                              ::com::sun::star::lang::WrappedTargetException );
  98
  99     /** Store the graphic content, represented through the <type>XGraphic</type>
 100         interface at the specified location
 101
 102         @param Graphic
 103             The graphic that should be stored
 104
 105         @param MediaProperties
 106             A sequence of property values to describe the destination
 107             location of the graphic
 108
 109         @see XGraphic
 110         @see MediaProperties
 111         @see com::sun::star::beans::PropertyValues
 112     */
 113     void                storeGraphic( [in] ::com::sun::star::graphic::XGraphic Graphic,
 114                               [in] ::com::sun::star::beans::PropertyValues MediaProperties  )
 115                     raises( ::com::sun::star::io::IOException,
 116                              ::com::sun::star::lang::IllegalArgumentException,
 117                             ::com::sun::star::lang::WrappedTargetException );
 118 };
 119
 120 } ; } ; } ; } ;
 121
 122 #endif