diff options
Diffstat (limited to 'offapi/com/sun/star/graphic/GraphicDescriptor.idl')
| -rw-r--r-- | offapi/com/sun/star/graphic/GraphicDescriptor.idl | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/offapi/com/sun/star/graphic/GraphicDescriptor.idl b/offapi/com/sun/star/graphic/GraphicDescriptor.idl new file mode 100644 index 000000000..daf3c88f9 --- /dev/null +++ b/offapi/com/sun/star/graphic/GraphicDescriptor.idl @@ -0,0 +1,157 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef com_sun_star_graphic_GraphicDescriptor_idl +#define com_sun_star_graphic_GraphicDescriptor_idl + +#include <com/sun/star/graphic/GraphicType.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/awt/Size.idl> + +module com { module sun { module star { module graphic +{ + +/** This service describes all graphic properties that are available + via the com::sun::star::beans::XPropertySet interface + + @see XPropertySet +*/ +published service GraphicDescriptor +{ + /** The property interface by which the properties of all + supported services are exchanged + */ + interface ::com::sun::star::beans::XPropertySet; + + /** The type of the graphic + + @see GraphicType + */ + [property] byte GraphicType; + + /** The MimeType of the loaded graphic + + <p> The mime can be the original mime type of the graphic + source the graphic container was constructed from or it + can be the internal mime type image/x-vclgraphic, in which + case the original mime type is not available anymore</p> + + <p> Currently, the following mime types are supported for + loaded graphics:</p> + <ul> + <li>image/bmp</li> + <li>image/gif</li> + <li>image/jpeg</li> + <li>image/x-photo-cd</li> + <li>image/x-pcx</li> + <li>image/png</li> + <li>image/tiff</li> + <li>image/x-xbitmap</li> + <li>image/x-xpixmap</li> + <li>image/x-portable-bitmap</li> + <li>image/x-portable-graymap</li> + <li>image/x-portable-pixmap</li> + <li>image/x-cmu-raster</li> + <li>image/x-targa</li> + <li>image/x-photoshop</li> + <li>image/x-eps</li> + <li>image/x-dxf</li> + <li>image/x-met</li> + <li>image/x-pict</li> + <li>image/x-svm</li> + <li>image/x-wmf</li> + <li>image/x-emf</li> + <li>image/svg+xml</li> + <li>application/pdf</li> + <li>image/x-vclgraphic</li> + </ul> + + */ + [property] string MimeType; + + /** The Size of the graphic in pixel. + + <p> This property may not be available in case of + vector graphics or if the pixel size can not be + determined correctly for some formats without loading + the whole graphic</p> + */ + [optional, property] ::com::sun::star::awt::Size SizePixel; + + /** The Size of the graphic in 100th mm. + + <p> This property may not be available in case of + pixel graphics or if the logical size can not be + determined correctly for some formats without loading + the whole graphic</p> + */ + [optional, property] ::com::sun::star::awt::Size Size100thMM; + + /** The number of bits per pixel used for the pixel graphic + + <p> This property is not available for vector + graphics and may not be available for some kinds + of pixel graphics</p> + */ + [optional, property] byte BitsPerPixel; + + /** Indicates that it is a transparent graphic + + <p>This property is always `TRUE` for vector graphics. + The status of this flag is not always clear if the + graphic was not loaded at all, e.g. in case of just + querying for the GraphicDescriptor.</p> + */ + [optional, property] boolean Transparent; + + /** Indicates that it is a pixel graphic with an alpha channel + + <p>The status of this flag is not always clear if the + graphic was not loaded at all, e.g. in case of just + querying for the GraphicDescriptor</p> + */ + [optional, property] boolean Alpha; + + /** Indicates that it is a graphic that consists of several + frames that can be played as an animation + + <p>The status of this flag is not always clear if the + graphic was not loaded at all, e.g. in case of just + querying for the GraphicDescriptor</p> + */ + [optional, property] boolean Animated; + + /** Indicates that the graphic is an external linked graphic + + @since LibreOffice 6.1 + */ + [optional, property] boolean Linked; + + /** The URL of the location from where the graphic was loaded from + + @since LibreOffice 6.1 + */ + [optional, property] string OriginURL; +}; + +} ; } ; } ; } ; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |