offapi/com/sun/star/gallery/GalleryItem.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 #ifndef __com_sun_star_gallery_GalleryItem_idl__
  21 #define __com_sun_star_gallery_GalleryItem_idl__
  22
  23 #include <com/sun/star/gallery/XGalleryItem.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/graphic/XGraphic.idl>
  26 #include <com/sun/star/lang/XComponent.idl>
  27
  28
  29 module com {  module sun {  module star {  module gallery {
  30
  31
  32 /** service to get access to the properties of a single Gallery item
  33  */
  34 service GalleryItem
  35 {
  36     interface ::com::sun::star::gallery::XGalleryItem;
  37
  38     interface ::com::sun::star::beans::XPropertySet;
  39
  40     /** The type of the Gallery item
  41
  42         @see GalleryItemType
  43     */
  44     [readonly, property] byte GalleryItemType;
  45
  46     /** the URL of the Gallery item
  47
  48         <p>The interpretation of the URL depends on the type
  49         of the Gallery item. In case of graphic and media items,
  50         the URL is a "real" URL, in case of drawings it is a private
  51         URL</p>
  52      */
  53     [readonly, property] string URL;
  54
  55     /** the title of the Gallery item
  56      */
  57     [property] string Title;
  58
  59     /** the thumbnail of the Gallery item
  60
  61         <p>The thumbnail may be either a pixel or a vector graphic</p>
  62      */
  63     [readonly, property] com::sun::star::graphic::XGraphic Thumbnail;
  64
  65     /** the graphic content of the Gallery item
  66
  67         <p>This is an optional property and may not available for every item</p>
  68      */
  69     [optional, readonly, property ] ::com::sun::star::graphic::XGraphic Graphic;
  70
  71     /** the drawing content of the Gallery item
  72
  73         <p>This is an optional property and may not available for every item</p>
  74      */
  75     [optional, readonly, property ] ::com::sun::star::lang::XComponent Drawing;
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */