offapi/com/sun/star/gallery/GalleryItem.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: GalleryItem.idl,v $
  10  * $Revision: 1.4 $
  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_gallery_GalleryItem_idl__
  32 #define __com_sun_star_gallery_GalleryItem_idl__
  33
  34 #ifndef __com_sun_star_gallery_XGalleryItem_idl__
  35 #include <com/sun/star/gallery/XGalleryItem.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40 #ifndef __com_sun_star_graphic_XGraphic_idl__
  41 #include <com/sun/star/graphic/XGraphic.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_XComponent_idl__
  44 #include <com/sun/star/lang/XComponent.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module gallery {
  50
  51 //=============================================================================
  52
  53 /** service to get access to the properties of a single Gallery item
  54  */
  55 service GalleryItem
  56 {
  57     interface ::com::sun::star::gallery::XGalleryItem;
  58
  59     interface ::com::sun::star::beans::XPropertySet;
  60
  61     /** The type of the Gallery item
  62
  63         @see GalleryItemType
  64     */
  65     [readonly, property] byte GalleryItemType;
  66
  67     /** the URL of the Gallery item
  68
  69         <p>The interpretation of the URL depends on the type
  70         of the Gallery item. In case of graphic and media items,
  71         the URL is a 'real' URL, in case of drawings it is a private
  72         URL</p>
  73      */
  74     [readonly, property] string URL;
  75
  76     /** the title of the Gallery item
  77      */
  78     [property] string Title;
  79
  80     /** the thumbnail of the Gallery item
  81
  82         <p>The thumbnail may be either a pixel or a vector graphic</p>
  83      */
  84     [readonly, property] com::sun::star::graphic::XGraphic Thumbnail;
  85
  86     /** the graphic content of the Gallery item
  87
  88         <p>This is an optional property and may not available for every item</p>
  89      */
  90     [optional, readonly, property ] ::com::sun::star::graphic::XGraphic Graphic;
  91
  92     /** the drawing content of the Gallery item
  93
  94         <p>This is an optional property and may not available for every item</p>
  95      */
  96     [optional, readonly, property ] ::com::sun::star::lang::XComponent Drawing;
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif