offapi/com/sun/star/gallery/XGalleryTheme.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: XGalleryTheme.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_XGalleryTheme_idl__
  32 #define __com_sun_star_gallery_XGalleryTheme_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37 #ifndef __com_sun_star_lang_XComponent_idl__
  38 #include <com/sun/star/lang/XComponent.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  41 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  44 #include <com/sun/star/lang/WrappedTargetException.idl>
  45 #endif
  46 #ifndef __com_sun_star_graphic_XGraphic_idl__
  47 #include <com/sun/star/graphic/XGraphic.idl>
  48 #endif
  49 #ifndef __com_sun_star_gallery_XGalleryItem_idl__
  50 #include <com/sun/star/gallery/XGalleryItem.idl>
  51 #endif
  52
  53 //=============================================================================
  54
  55 module com {  module sun {  module star {  module gallery {
  56
  57 //=============================================================================
  58
  59 /** provides access to the items of a Gallery themes. It also allows
  60     inserting and removing of single items.
  61
  62     <p>This interface extends the interface
  63     <type scope="com::sun::star::container">XIndexAccess</type> which provides
  64     access to existing Gallery items collection.</p>
  65
  66     @see com::sun::star::container::XIndexAccess
  67     @see com::sun::star::sheet::DataPilotTable
  68  */
  69 interface XGalleryTheme : com::sun::star::container::XIndexAccess
  70 {
  71     /** retrieves the name of the Gallery theme
  72
  73         @returns
  74             The name of the Gallery theme
  75      */
  76     string getName();
  77
  78     /** updates the theme
  79
  80         <p>This method iterates over each item of the Gallery theme
  81         and updates it accordingly. Main purpose is to automatically
  82         regenerate the thumbnails and to remove invalid items, that is items
  83         who have got an URL that has become invalid. This method also
  84         optimizes underlying data structures.</p>
  85      */
  86     void update();
  87
  88     /** inserts an item
  89
  90         @param URL
  91             The URL of a graphic or media object, that should
  92             be added to the collection
  93
  94         @param Index
  95             The zero based index of the position where to insert
  96             the new object inside the collection. If the index is larger than
  97             or equal to the number of already inserted items, the
  98             item is inserted at the end of the collection. If the index
  99             is smaller than 0, the item is inserted at the beginning of
 100             the collection.
 101
 102         @returns
 103             The zero based position at which the object was inserted.
 104             If the object could not be inserted, -1 is returned.
 105
 106         @see XGalleryItem
 107         @see com::sun::star::lang::WrappedTargetException
 108     */
 109     long insertURLByIndex( [in] string URL, [in] long Index )
 110         raises ( com::sun::star::lang::WrappedTargetException );
 111     /** inserts an item
 112
 113         @param Graphic
 114             The <type scope="com::sun::star::graphic">XGraphic</type> object
 115             that should be added to the collection
 116
 117         @param Index
 118             The zero based index of the position where to insert
 119             the new object inside the collection. If the index is larger than
 120             or equal to the number of already inserted items, the
 121             item is inserted at the end of the collection. If the index
 122             is smaller than 0, the item is inserted at the beginning of
 123             the collection.
 124
 125         @returns
 126             The zero based position at which the object was inserted.
 127             If the object could not be inserted, -1 is returned.
 128
 129         @see com::sun::star::graphic::XGraphic
 130         @see XGalleryItem
 131         @see com::sun::star::lang::WrappedTargetException
 132     */
 133     long insertGraphicByIndex( [in] com::sun::star::graphic::XGraphic Graphic, [in] long Index )
 134         raises ( com::sun::star::lang::WrappedTargetException );
 135
 136     /** inserts an item
 137
 138         @param Drawing
 139             A drawing model that should be added to the collection
 140
 141         @param Index
 142             The zero based index of the position where to insert
 143             the new object inside the collection. If the index is larger than
 144             or equal to the number of already inserted items, the
 145             item is inserted at the end of the collection. If the index
 146             is smaller than 0, the item is inserted at the beginning of
 147             the collection.
 148
 149         @returns
 150             The zero based position at which the object was inserted.
 151             If the object could not be inserted, -1 is returned.
 152
 153         @see XGalleryItem
 154         @see com::sun::star::lang::WrappedTargetException
 155     */
 156     long insertDrawingByIndex( [in] com::sun::star::lang::XComponent Drawing, [in] long Index )
 157         raises ( com::sun::star::lang::WrappedTargetException );
 158
 159     /** deletes an item from the collection
 160
 161         @param Index
 162             The position of the item to be removed. The
 163             position is zero based.
 164
 165         @see com::sun::star::container::NoSuchElementException
 166     */
 167     void removeByIndex( [in] long Index )
 168         raises ( com::sun::star::lang::IndexOutOfBoundsException );
 169 };
 170
 171 //=============================================================================
 172
 173 }; }; }; };
 174
 175 #endif