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