offapi/com/sun/star/graphic/MediaProperties.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: MediaProperties.idl,v $
  10  * $Revision: 1.6 $
  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_MediaProperties_idl
  32 #define com_sun_star_graphic_MediaProperties_idl
  33
  34 #include <com/sun/star/beans/PropertyValues.idl>
  35 #include <com/sun/star/io/XInputStream.idl>
  36 #include <com/sun/star/io/XStream.idl>
  37
  38 module com { module sun { module star { module graphic
  39 {
  40
  41 /** This service describes the properties that are used
  42     when using the <type>XGraphicProvider</type> interface methods
  43 */
  44 published service MediaProperties
  45 {
  46     /** Property that describes the location of the source or target
  47         of the graphic as URL.
  48
  49         <p>A URL can be used instead of the
  50         <member>InputStream</member> or <member>OutputStream</member>
  51         property</p>
  52
  53         <p>In addition to the normal protocols like file:// or http://
  54         you can use private URL's as follows to get access to graphics
  55         lying inside the resource system within an Office context:
  56
  57         <ul>
  58             <li>private:resource/projectshortname/bitmap/12345</li>
  59             <li>private:resource/projectshortname/bitmapex/12345</li>
  60             <li>private:resource/projectshortname/image/12345</li>
  61             <li>private:resource/projectshortname/imagelist/12345</li>
  62             <li>private:resource/projectshortname/imagelist/12345/12</li>
  63         </ul>
  64 And additionally, GraphicObject scheme url's like
  65             <ul> <li>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</li> </ul>
  66               can be used to access graphics held by the GraphicCache implementation.
  67         </p>
  68
  69         <p>Yet more, you can access graphics in the application-wide image
  70         repository by specifying URLs of the form
  71         <code>private:graphicrepository/<em>&lt;path_in_repository&gt;</em></code>.
  72 </p>
  73     */
  74     [optional, property ] string URL;
  75
  76     /** This property is only used for loading graphics or querying
  77         graphic descriptors
  78
  79         <p>A <member>InputStream</member> can be used instead of the
  80         <member>URL</member> property</p>
  81
  82         @see com::sun::star::io::XInputStream
  83     */
  84     [optional, property ] ::com::sun::star::io::XInputStream InputStream;
  85
  86     /** This property is only used for storing graphics
  87
  88         <p>A <member>OutputStream</member> can be used instead of the
  89         <member>URL</member> property</p>
  90
  91         @see com::sun::star::io::XStream
  92     */
  93     [optional, property ] ::com::sun::star::io::XStream OutputStream;
  94
  95     /** This property is only used for storing graphics and describes the
  96         format into which the graphic is to be converted
  97
  98         <p>At the moment, the following mime types are supported for storing
  99         graphics:</p>
 100
 101         <ul>
 102             <li>image/bmp</li>
 103             <li>image/gif</li>
 104             <li>image/jpeg</li>
 105             <li>image/png</li>
 106             <li>image/tiff</li>
 107             <li>image/svg+xml</li>
 108             <li>image/x-cmu-raster</li>
 109             <li>image/x-emf</li>
 110             <li>image/x-eps</li>
 111             <li>image/x-met</li>
 112             <li>image/x-pict</li>
 113             <li>image/x-portable-bitmap</li>
 114             <li>image/x-portable-pixmap</li>
 115             <li>image/x-wmf</li>
 116             <li>image/x-svm</li>
 117             <li>image/x-xpixmap</li>
 118             <li>image/x-vclgraphic</li>
 119         </ul>
 120     */
 121     [optional, property ] string MimeType;
 122
 123     /** Additional properties that will be passed to the
 124     appropriate filter module.
 125     */
 126     [optional, property] ::com::sun::star::beans::PropertyValues FilterData;
 127 };
 128
 129 } ; } ; } ; } ;
 130
 131 #endif