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