offapi/com/sun/star/graphic/GraphicDescriptor.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 all graphic properties that are available
  24     via the com::sun::star::beans::XPropertySet interface
  25
  26     @see XPropertySet
  27 */
  28 published service GraphicDescriptor
  29 {
  30     /** The property interface by which the properties of all
  31         supported services are exchanged
  32     */
  33     interface ::com::sun::star::beans::XPropertySet;
  34
  35     /** The type of the graphic
  36
  37         @see GraphicType
  38     */
  39     [property] byte GraphicType;
  40
  41     /** The MimeType of the loaded graphic
  42
  43         <p> The mime can be the original mime type of the graphic
  44         source the graphic container was constructed from or it
  45         can be the internal mime type image/x-vclgraphic, in which
  46         case the original mime type is not available anymore</p>
  47
  48         <p> Currently, the following mime types are supported for
  49         loaded graphics:</p>
  50         <ul>
  51             <li>image/bmp</li>
  52             <li>image/gif</li>
  53             <li>image/jpeg</li>
  54             <li>image/x-photo-cd</li>
  55             <li>image/x-pcx</li>
  56             <li>image/png</li>
  57             <li>image/tiff</li>
  58             <li>image/x-xbitmap</li>
  59             <li>image/x-xpixmap</li>
  60             <li>image/x-portable-bitmap</li>
  61             <li>image/x-portable-graymap</li>
  62             <li>image/x-portable-pixmap</li>
  63             <li>image/x-cmu-raster</li>
  64             <li>image/x-targa</li>
  65             <li>image/x-photoshop</li>
  66             <li>image/x-eps</li>
  67             <li>image/x-dxf</li>
  68             <li>image/x-met</li>
  69             <li>image/x-pict</li>
  70             <li>image/x-svm</li>
  71             <li>image/x-wmf</li>
  72             <li>image/x-emf</li>
  73             <li>image/svg+xml</li>
  74             <li>application/pdf</li>
  75             <li>image/x-vclgraphic</li>
  76         </ul>
  77
  78     */
  79     [property] string MimeType;
  80
  81     /** The Size of the graphic in pixel.
  82
  83         <p> This property may not be available in case of
  84         vector graphics or if the pixel size can not be
  85         determined correctly for some formats without loading
  86         the whole graphic</p>
  87     */
  88     [optional, property] ::com::sun::star::awt::Size SizePixel;
  89
  90     /** The Size of the graphic in 100th mm.
  91
  92         <p> This property may not be available in case of
  93         pixel graphics or if the logical size can not be
  94         determined correctly for some formats without loading
  95         the whole graphic</p>
  96     */
  97     [optional, property] ::com::sun::star::awt::Size Size100thMM;
  98
  99     /** The number of bits per pixel used for the pixel graphic
 100
 101         <p> This property is not available for vector
 102         graphics and may not be available for some kinds
 103         of pixel graphics</p>
 104     */
 105     [optional, property] byte BitsPerPixel;
 106
 107     /** Indicates that it is a transparent graphic
 108
 109         <p>This property is always `TRUE` for vector graphics.
 110         The status of this flag is not always clear if the
 111         graphic was not loaded at all, e.g. in case of just
 112         querying for the GraphicDescriptor.</p>
 113     */
 114     [optional, property] boolean Transparent;
 115
 116     /** Indicates that it is a pixel graphic with an alpha channel
 117
 118         <p>The status of this flag is not always clear if the
 119         graphic was not loaded at all, e.g. in case of just
 120         querying for the GraphicDescriptor</p>
 121     */
 122     [optional, property] boolean Alpha;
 123
 124     /** Indicates that it is a graphic that consists of several
 125         frames that can be played as an animation
 126
 127         <p>The status of this flag is not always clear if the
 128         graphic was not loaded at all, e.g. in case of just
 129         querying for the GraphicDescriptor</p>
 130     */
 131     [optional, property] boolean Animated;
 132
 133     /** Indicates that the graphic is an external linked graphic
 134
 135         @since LibreOffice 6.1
 136     */
 137     [optional, property] boolean Linked;
 138
 139     /** The URL of the location from where the graphic was loaded from
 140
 141         @since LibreOffice 6.1
 142     */
 143     [optional, property] string OriginURL;
 144 };
 145
 146 } ; } ; } ; } ;
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */