offapi/com/sun/star/gallery/XGalleryThemeProvider.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: XGalleryThemeProvider.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_XGalleryThemeProvider_idl__
  32 #define __com_sun_star_gallery_XGalleryThemeProvider_idl__
  33
  34 #ifndef __com_sun_star_gallery_XGalleryTheme_idl__
  35 #include <com/sun/star/gallery/XGalleryTheme.idl>
  36 #endif
  37 #ifndef __com_sun_star_container_XNameAccess_idl__
  38 #include <com/sun/star/container/XNameAccess.idl>
  39 #endif
  40 #ifndef __com_sun_star_container_ElementExistException_idl__
  41 #include <com/sun/star/container/ElementExistException.idl>
  42 #endif
  43 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  44 #include <com/sun/star/container/NoSuchElementException.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module gallery {
  50
  51 //=============================================================================
  52
  53 /** provides access to the Gallery themes. It also allows inserting and
  54     removing of Gallery themes by name.
  55
  56     <p>This interface extends the interface
  57     <type scope="com::sun::star::container">XNameAccess</type> which provides
  58     access to existing Gallery themes collection.</p>
  59
  60     @see com::sun::star::container::XNameAccess
  61  */
  62 interface XGalleryThemeProvider : com::sun::star::container::XNameAccess
  63 {
  64     /** creates a new Gallery theme and adds it to the collection.
  65
  66         @param ThemeName
  67             The name of the Gallery theme to be added to the collection.
  68             The name must be unique.
  69
  70         @returns XGalleryTheme
  71             The created theme interface
  72
  73         @see com::sun::star::container::ElementExistException
  74      */
  75     XGalleryTheme insertNewByName( [in] string ThemeName )
  76         raises ( com::sun::star::container::ElementExistException );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** deletes a Gallery theme from the collection.
  81
  82         @param ThemeName
  83             The name of the Gallery theme to be removed. The
  84             theme with the given name must exist.
  85
  86         @see com::sun::star::container::NoSuchElementException
  87     */
  88     void removeByName( [in] string ThemeName )
  89         raises ( com::sun::star::container::NoSuchElementException );
  90
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 #endif