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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef com_sun_star_graphic_MediaProperties_idl
  30 #define com_sun_star_graphic_MediaProperties_idl
  31
  32 #include <com/sun/star/beans/PropertyValues.idl>
  33 #include <com/sun/star/io/XInputStream.idl>
  34 #include <com/sun/star/io/XStream.idl>
  35
  36 module com { module sun { module star { module graphic
  37 {
  38
  39 /** This service describes the properties that are used
  40     when using the <type>XGraphicProvider</type> interface methods
  41 */
  42 published service MediaProperties
  43 {
  44     /** Property that describes the location of the source or target
  45         of the graphic as URL.
  46
  47         <p>A URL can be used instead of the
  48         <member>InputStream</member> or <member>OutputStream</member>
  49         property</p>
  50
  51         <p>In addition to the normal protocols like file:// or http://
  52         you can use private URLs as follows to get access to graphics
  53         lying inside the resource system within an Office context:
  54
  55         <ul>
  56             <li>private:resource/projectshortname/bitmap/12345</li>
  57             <li>private:resource/projectshortname/bitmapex/12345</li>
  58             <li>private:resource/projectshortname/image/12345</li>
  59             <li>private:resource/projectshortname/imagelist/12345</li>
  60             <li>private:resource/projectshortname/imagelist/12345/12</li>
  61         </ul>
  62 And additionally, GraphicObject scheme URLs like
  63             <ul> <li>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</li> </ul>
  64               can be used to access graphics held by the GraphicCache implementation.
  65         </p>
  66
  67         <p>Yet more, you can access graphics in the application-wide image
  68         repository by specifying URLs of the form
  69         <code>private:graphicrepository/<em>&lt;path_in_repository&gt;</em></code>.
  70 </p>
  71     */
  72     [optional, property ] string URL;
  73
  74     /** This property is only used for loading graphics or querying
  75         graphic descriptors
  76
  77         <p>A <member>InputStream</member> can be used instead of the
  78         <member>URL</member> property</p>
  79
  80         @see com::sun::star::io::XInputStream
  81     */
  82     [optional, property ] ::com::sun::star::io::XInputStream InputStream;
  83
  84     /** This property is only used for storing graphics
  85
  86         <p>A <member>OutputStream</member> can be used instead of the
  87         <member>URL</member> property</p>
  88
  89         @see com::sun::star::io::XStream
  90     */
  91     [optional, property ] ::com::sun::star::io::XStream OutputStream;
  92
  93     /** This property is only used for storing graphics and describes the
  94         format into which the graphic is to be converted
  95
  96         <p>At the moment, the following mime types are supported for storing
  97         graphics:</p>
  98
  99         <ul>
 100             <li>image/bmp</li>
 101             <li>image/gif</li>
 102             <li>image/jpeg</li>
 103             <li>image/png</li>
 104             <li>image/tiff</li>
 105             <li>image/svg+xml</li>
 106             <li>image/x-cmu-raster</li>
 107             <li>image/x-emf</li>
 108             <li>image/x-eps</li>
 109             <li>image/x-met</li>
 110             <li>image/x-pict</li>
 111             <li>image/x-portable-bitmap</li>
 112             <li>image/x-portable-pixmap</li>
 113             <li>image/x-wmf</li>
 114             <li>image/x-svm</li>
 115             <li>image/x-xpixmap</li>
 116             <li>image/x-vclgraphic</li>
 117         </ul>
 118     */
 119     [optional, property ] string MimeType;
 120
 121     /** Additional properties that will be passed to the
 122     appropriate filter module.
 123     */
 124     [optional, property] ::com::sun::star::beans::PropertyValues FilterData;
 125 };
 126
 127 } ; } ; } ; } ;
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */