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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: GraphicDescriptor.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef com_sun_star_graphic_GraphicDescriptor_idl
  32 #define com_sun_star_graphic_GraphicDescriptor_idl
  33
  34 #include <com/sun/star/graphic/GraphicType.idl>
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #include <com/sun/star/awt/Size.idl>
  37
  38 module com { module sun { module star { module graphic
  39 {
  40
  41 /** This service describes all graphic properties that are available
  42     via the <type scope="com::sun::star::beans">XPropertySet</type> interface
  43
  44     @see XPropertySet
  45 */
  46 published service GraphicDescriptor
  47 {
  48     /** The property interface by which the properties of all
  49         supported services are exchanged
  50     */
  51     interface ::com::sun::star::beans::XPropertySet;
  52
  53     /** The type of the graphic
  54
  55         @see GraphicType
  56     */
  57     [property] byte GraphicType;
  58
  59     /** The MimeType of the loaded graphic
  60
  61         <p> The mime can be the original mime type of the graphic
  62         source the graphic container was constructed from or it
  63         can be the internal mime type image/x-vclgraphic, in which
  64         case the original mime type is not available anymore</p>
  65
  66         <p> Currently, the following mime types are supported for
  67         loaded graphics:<\p>
  68         <ul>
  69             <li>image/bmp</li>
  70             <li>image/gif</li>
  71             <li>image/jpeg</li>
  72             <li>image/x-photo-cd</li>
  73             <li>image/x-pcx</li>
  74             <li>image/png</li>
  75             <li>image/tiff</li>
  76             <li>image/x-xbitmap</li>
  77             <li>image/x-xpixmap</li>
  78             <li>image/x-portable-bitmap</li>
  79             <li>image/x-portable-graymap</li>
  80             <li>image/x-portable-pixmap</li>
  81             <li>image/x-cmu-raster</li>
  82             <li>image/x-targa</li>
  83             <li>image/x-photoshop</li>
  84             <li>image/x-eps</li>
  85             <li>image/x-dxf</li>
  86             <li>image/x-met</li>
  87             <li>image/x-pict</li>
  88             <li>image/x-sgf</li>
  89             <li>image/x-svm</li>
  90             <li>image/x-wmf</li>
  91             <li>image/x-sgv</li>
  92             <li>image/x-emf</li>
  93             <li>image/x-vclgraphic</li>
  94         </ul>
  95
  96     */
  97     [property] string MimeType;
  98
  99     /** The Size of the graphic in pixel.
 100
 101         <p> This property may not be available in case of
 102         vector graphics or if the pixel size can not be
 103         determined correctly for some formats without loading
 104         the whole graphic</p>
 105     */
 106     [optional, property] ::com::sun::star::awt::Size SizePixel;
 107
 108     /** The Size of the graphic in 100th mm.
 109
 110         <p> This property may not be available in case of
 111         pixel graphics or if the logical size can not be
 112         determined correctly for some formats without loading
 113         the whole graphic</p>
 114     */
 115     [optional, property] ::com::sun::star::awt::Size Size100thMM;
 116
 117     /** The number of bits per pixel used for the pixel graphic
 118
 119         <p> This property is not available for vector
 120         graphics and may not be available for some kinds
 121         of pixel graphics</p>
 122     */
 123     [optional, property] byte BitsPerPixel;
 124
 125     /** Indicates that it is a transparent graphic
 126
 127         <p>This property is always <TRUE/> for vector graphics.
 128         The status of this flag is not always clear if the
 129         graphic was not loaded at all, e.g. in case of just
 130         querying for the <type>GraphicDescriptor</type>.</p>
 131     */
 132     [optional, property] boolean Transparent;
 133
 134     /** Indicates that it is a pixel graphic with an alpha channel
 135
 136         <p>The status of this flag is not always clear if the
 137         graphic was not loaded at all, e.g. in case of just
 138         querying for the <type>GraphicDescriptor</type></p>
 139     */
 140     [optional, property] boolean Alpha;
 141
 142     /** Indicates that it is a graphic that consists of several
 143         frames that can be played as an animation
 144
 145         <p>The status of this flag is not always clear if the
 146         graphic was not loaded at all, e.g. in case of just
 147         querying for the <type>GraphicDescriptor</type></p>
 148     */
 149     [optional, property] boolean Animated;
 150 };
 151
 152 } ; } ; } ; } ;
 153
 154 #endif