1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef com_sun_star_graphic_GraphicDescriptor_idl
25#define com_sun_star_graphic_GraphicDescriptor_idl
26
27#include <com/sun/star/graphic/GraphicType.idl>
28#include <com/sun/star/beans/XPropertySet.idl>
29#include <com/sun/star/awt/Size.idl>
30
31module com { module sun { module star { module graphic
32{
33
34/** This service describes all graphic properties that are available
35	via the <type scope="com::sun::star::beans">XPropertySet</type> interface
36
37	@see XPropertySet
38*/
39published service GraphicDescriptor
40{
41    /** The property interface by which the properties of all
42        supported services are exchanged
43    */
44    interface ::com::sun::star::beans::XPropertySet;
45
46	/** The type of the graphic
47
48		@see GraphicType
49	*/
50	[property] byte GraphicType;
51
52	/** The MimeType of the loaded graphic
53
54		<p> The mime can be the original mime type of the graphic
55		source the graphic container was constructed from or it
56		can be the internal mime type image/x-vclgraphic, in which
57		case the original mime type is not available anymore</p>
58
59		<p> Currently, the following mime types are supported for
60		loaded graphics:</p>
61		<ul>
62			<li>image/bmp</li>
63			<li>image/gif</li>
64			<li>image/jpeg</li>
65			<li>image/x-photo-cd</li>
66			<li>image/x-pcx</li>
67			<li>image/png</li>
68			<li>image/tiff</li>
69			<li>image/x-xbitmap</li>
70			<li>image/x-xpixmap</li>
71			<li>image/x-portable-bitmap</li>
72			<li>image/x-portable-graymap</li>
73			<li>image/x-portable-pixmap</li>
74			<li>image/x-cmu-raster</li>
75			<li>image/x-targa</li>
76			<li>image/x-photoshop</li>
77			<li>image/x-eps</li>
78			<li>image/x-dxf</li>
79			<li>image/x-met</li>
80			<li>image/x-pict</li>
81			<li>image/x-sgf</li>
82			<li>image/x-svm</li>
83			<li>image/x-wmf</li>
84			<li>image/x-sgv</li>
85			<li>image/x-emf</li>
86			<li>image/x-vclgraphic</li>
87		</ul>
88
89	*/
90	[property] string MimeType;
91
92	/** The Size of the graphic in pixel.
93
94		<p> This property may not be available in case of
95		vector graphics or if the pixel size can not be
96		determined correctly for some formats without loading
97		the whole graphic</p>
98	*/
99	[optional, property] ::com::sun::star::awt::Size SizePixel;
100
101	/** The Size of the graphic in 100th mm.
102
103		<p> This property may not be available in case of
104		pixel graphics or if the logical size can not be
105		determined correctly for some formats without loading
106		the whole graphic</p>
107	*/
108	[optional, property] ::com::sun::star::awt::Size Size100thMM;
109
110	/** The number of bits per pixel used for the pixel graphic
111
112		<p> This property is not available for vector
113		graphics and may not be available for some kinds
114		of pixel graphics</p>
115	*/
116	[optional, property] byte BitsPerPixel;
117
118	/** Indicates that it is a transparent graphic
119
120		<p>This property is always <TRUE/> for vector graphics.
121		The status of this flag is not always clear if the
122		graphic was not loaded at all, e.g. in case of just
123		querying for the <type>GraphicDescriptor</type>.</p>
124	*/
125	[optional, property] boolean Transparent;
126
127	/** Indicates that it is a pixel graphic with an alpha channel
128
129		<p>The status of this flag is not always clear if the
130		graphic was not loaded at all, e.g. in case of just
131		querying for the <type>GraphicDescriptor</type></p>
132	*/
133	[optional, property] boolean Alpha;
134
135	/** Indicates that it is a graphic that consists of several
136		frames that can be played as an animation
137
138		<p>The status of this flag is not always clear if the
139		graphic was not loaded at all, e.g. in case of just
140		querying for the <type>GraphicDescriptor</type></p>
141	*/
142	[optional, property] boolean Animated;
143};
144
145} ; } ; } ; } ;
146
147#endif
148