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