1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef com_sun_star_graphic_MediaProperties_idl 25cdf0e10cSrcweir#define com_sun_star_graphic_MediaProperties_idl 26cdf0e10cSrcweir 27cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValues.idl> 28cdf0e10cSrcweir#include <com/sun/star/io/XInputStream.idl> 29cdf0e10cSrcweir#include <com/sun/star/io/XStream.idl> 30cdf0e10cSrcweir 31cdf0e10cSrcweirmodule com { module sun { module star { module graphic 32cdf0e10cSrcweir{ 33cdf0e10cSrcweir 34cdf0e10cSrcweir/** This service describes the properties that are used 35cdf0e10cSrcweir when using the <type>XGraphicProvider</type> interface methods 36cdf0e10cSrcweir*/ 37cdf0e10cSrcweirpublished service MediaProperties 38cdf0e10cSrcweir{ 39cdf0e10cSrcweir /** Property that describes the location of the source or target 40cdf0e10cSrcweir of the graphic as URL. 41cdf0e10cSrcweir 42cdf0e10cSrcweir <p>A URL can be used instead of the 43cdf0e10cSrcweir <member>InputStream</member> or <member>OutputStream</member> 44cdf0e10cSrcweir property</p> 45cdf0e10cSrcweir 46cdf0e10cSrcweir <p>In addition to the normal protocols like file:// or http:// 47cdf0e10cSrcweir you can use private URL's as follows to get access to graphics 48cdf0e10cSrcweir lying inside the resource system within an Office context: 49cdf0e10cSrcweir 50cdf0e10cSrcweir <ul> 51cdf0e10cSrcweir <li>private:resource/projectshortname/bitmap/12345</li> 52cdf0e10cSrcweir <li>private:resource/projectshortname/bitmapex/12345</li> 53cdf0e10cSrcweir <li>private:resource/projectshortname/image/12345</li> 54cdf0e10cSrcweir <li>private:resource/projectshortname/imagelist/12345</li> 55cdf0e10cSrcweir <li>private:resource/projectshortname/imagelist/12345/12</li> 56cdf0e10cSrcweir </ul> 57cdf0e10cSrcweirAnd additionally, GraphicObject scheme url's like 58cdf0e10cSrcweir <ul> <li>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</li> </ul> 59cdf0e10cSrcweir can be used to access graphics held by the GraphicCache implementation. 60cdf0e10cSrcweir </p> 61cdf0e10cSrcweir 62cdf0e10cSrcweir <p>Yet more, you can access graphics in the application-wide image 63cdf0e10cSrcweir repository by specifying URLs of the form 64cdf0e10cSrcweir <code>private:graphicrepository/<em><path_in_repository></em></code>. 65cdf0e10cSrcweir</p> 66cdf0e10cSrcweir */ 67cdf0e10cSrcweir [optional, property ] string URL; 68cdf0e10cSrcweir 69cdf0e10cSrcweir /** This property is only used for loading graphics or querying 70cdf0e10cSrcweir graphic descriptors 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p>A <member>InputStream</member> can be used instead of the 73cdf0e10cSrcweir <member>URL</member> property</p> 74cdf0e10cSrcweir 75cdf0e10cSrcweir @see com::sun::star::io::XInputStream 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir [optional, property ] ::com::sun::star::io::XInputStream InputStream; 78cdf0e10cSrcweir 79cdf0e10cSrcweir /** This property is only used for storing graphics 80cdf0e10cSrcweir 81cdf0e10cSrcweir <p>A <member>OutputStream</member> can be used instead of the 82cdf0e10cSrcweir <member>URL</member> property</p> 83cdf0e10cSrcweir 84cdf0e10cSrcweir @see com::sun::star::io::XStream 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir [optional, property ] ::com::sun::star::io::XStream OutputStream; 87cdf0e10cSrcweir 88cdf0e10cSrcweir /** This property is only used for storing graphics and describes the 89cdf0e10cSrcweir format into which the graphic is to be converted 90cdf0e10cSrcweir 91cdf0e10cSrcweir <p>At the moment, the following mime types are supported for storing 92cdf0e10cSrcweir graphics:</p> 93cdf0e10cSrcweir 94cdf0e10cSrcweir <ul> 95cdf0e10cSrcweir <li>image/bmp</li> 96cdf0e10cSrcweir <li>image/gif</li> 97cdf0e10cSrcweir <li>image/jpeg</li> 98cdf0e10cSrcweir <li>image/png</li> 99cdf0e10cSrcweir <li>image/tiff</li> 100cdf0e10cSrcweir <li>image/svg+xml</li> 101cdf0e10cSrcweir <li>image/x-cmu-raster</li> 102cdf0e10cSrcweir <li>image/x-emf</li> 103cdf0e10cSrcweir <li>image/x-eps</li> 104cdf0e10cSrcweir <li>image/x-met</li> 105cdf0e10cSrcweir <li>image/x-pict</li> 106cdf0e10cSrcweir <li>image/x-portable-bitmap</li> 107cdf0e10cSrcweir <li>image/x-portable-pixmap</li> 108cdf0e10cSrcweir <li>image/x-wmf</li> 109cdf0e10cSrcweir <li>image/x-svm</li> 110cdf0e10cSrcweir <li>image/x-xpixmap</li> 111cdf0e10cSrcweir <li>image/x-vclgraphic</li> 112cdf0e10cSrcweir </ul> 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir [optional, property ] string MimeType; 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** Additional properties that will be passed to the 117cdf0e10cSrcweir appropriate filter module. 118cdf0e10cSrcweir */ 119cdf0e10cSrcweir [optional, property] ::com::sun::star::beans::PropertyValues FilterData; 120cdf0e10cSrcweir}; 121cdf0e10cSrcweir 122cdf0e10cSrcweir} ; } ; } ; } ; 123cdf0e10cSrcweir 124cdf0e10cSrcweir#endif 125