offapi/com/sun/star/gallery/GalleryItem.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_gallery_GalleryItem_idl__
  30 #define __com_sun_star_gallery_GalleryItem_idl__
  31
  32 #include <com/sun/star/gallery/XGalleryItem.idl>
  33 #include <com/sun/star/beans/XPropertySet.idl>
  34 #include <com/sun/star/graphic/XGraphic.idl>
  35 #include <com/sun/star/lang/XComponent.idl>
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module gallery {
  40
  41 //=============================================================================
  42
  43 /** service to get access to the properties of a single Gallery item
  44  */
  45 service GalleryItem
  46 {
  47     interface ::com::sun::star::gallery::XGalleryItem;
  48
  49     interface ::com::sun::star::beans::XPropertySet;
  50
  51     /** The type of the Gallery item
  52
  53         @see GalleryItemType
  54     */
  55     [readonly, property] byte GalleryItemType;
  56
  57     /** the URL of the Gallery item
  58
  59         <p>The interpretation of the URL depends on the type
  60         of the Gallery item. In case of graphic and media items,
  61         the URL is a "real" URL, in case of drawings it is a private
  62         URL</p>
  63      */
  64     [readonly, property] string URL;
  65
  66     /** the title of the Gallery item
  67      */
  68     [property] string Title;
  69
  70     /** the thumbnail of the Gallery item
  71
  72         <p>The thumbnail may be either a pixel or a vector graphic</p>
  73      */
  74     [readonly, property] com::sun::star::graphic::XGraphic Thumbnail;
  75
  76     /** the graphic content of the Gallery item
  77
  78         <p>This is an optional property and may not available for every item</p>
  79      */
  80     [optional, readonly, property ] ::com::sun::star::graphic::XGraphic Graphic;
  81
  82     /** the drawing content of the Gallery item
  83
  84         <p>This is an optional property and may not available for every item</p>
  85      */
  86     [optional, readonly, property ] ::com::sun::star::lang::XComponent Drawing;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */