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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_gallery_XGalleryThemeProvider_idl__
  21 #define __com_sun_star_gallery_XGalleryThemeProvider_idl__
  22
  23 #include <com/sun/star/gallery/XGalleryTheme.idl>
  24 #include <com/sun/star/container/XNameAccess.idl>
  25 #include <com/sun/star/container/ElementExistException.idl>
  26 #include <com/sun/star/container/NoSuchElementException.idl>
  27
  28
  29 module com {  module sun {  module star {  module gallery {
  30
  31
  32 /** provides access to the Gallery themes. It also allows inserting and
  33     removing of Gallery themes by name.
  34
  35     <p>This interface extends the interface
  36     com::sun::star::container::XNameAccess which provides
  37     access to existing Gallery themes collection.</p>
  38
  39     @see com::sun::star::container::XNameAccess
  40  */
  41 interface XGalleryThemeProvider : com::sun::star::container::XNameAccess
  42 {
  43     /** creates a new Gallery theme and adds it to the collection.
  44
  45         @param ThemeName
  46             The name of the Gallery theme to be added to the collection.
  47             The name must be unique.
  48
  49         @returns XGalleryTheme
  50             The created theme interface
  51
  52         @see com::sun::star::container::ElementExistException
  53      */
  54     XGalleryTheme insertNewByName( [in] string ThemeName )
  55         raises ( com::sun::star::container::ElementExistException );
  56
  57
  58     /** deletes a Gallery theme from the collection.
  59
  60         @param ThemeName
  61             The name of the Gallery theme to be removed. The
  62             theme with the given name must exist.
  63
  64         @see com::sun::star::container::NoSuchElementException
  65     */
  66     void removeByName( [in] string ThemeName )
  67         raises ( com::sun::star::container::NoSuchElementException );
  68
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */