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
  21 module com {  module sun {  module star {  module gallery {
  22
  23
  24 /** provides access to the Gallery themes. It also allows inserting and
  25     removing of Gallery themes by name.
  26
  27     <p>This interface extends the interface
  28     com::sun::star::container::XNameAccess which provides
  29     access to existing Gallery themes collection.</p>
  30
  31     @see com::sun::star::container::XNameAccess
  32  */
  33 interface XGalleryThemeProvider : com::sun::star::container::XNameAccess
  34 {
  35     /** creates a new Gallery theme and adds it to the collection.
  36
  37         @param ThemeName
  38             The name of the Gallery theme to be added to the collection.
  39             The name must be unique.
  40
  41         @returns XGalleryTheme
  42             The created theme interface
  43
  44         @see com::sun::star::container::ElementExistException
  45      */
  46     XGalleryTheme insertNewByName( [in] string ThemeName )
  47         raises ( com::sun::star::container::ElementExistException );
  48
  49
  50     /** deletes a Gallery theme from the collection.
  51
  52         @param ThemeName
  53             The name of the Gallery theme to be removed. The
  54             theme with the given name must exist.
  55
  56         @see com::sun::star::container::NoSuchElementException
  57     */
  58     void removeByName( [in] string ThemeName )
  59         raises ( com::sun::star::container::NoSuchElementException );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */