xref: /AOO41X/main/offapi/com/sun/star/gallery/XGalleryThemeProvider.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_gallery_XGalleryThemeProvider_idl__
25#define __com_sun_star_gallery_XGalleryThemeProvider_idl__
26
27#ifndef __com_sun_star_gallery_XGalleryTheme_idl__
28#include <com/sun/star/gallery/XGalleryTheme.idl>
29#endif
30#ifndef __com_sun_star_container_XNameAccess_idl__
31#include <com/sun/star/container/XNameAccess.idl>
32#endif
33#ifndef __com_sun_star_container_ElementExistException_idl__
34#include <com/sun/star/container/ElementExistException.idl>
35#endif
36#ifndef __com_sun_star_container_NoSuchElementException_idl__
37#include <com/sun/star/container/NoSuchElementException.idl>
38#endif
39
40//=============================================================================
41
42module com {  module sun {  module star {  module gallery {
43
44//=============================================================================
45
46/** provides access to the Gallery themes. It also allows inserting and
47    removing of Gallery themes by name.
48
49    <p>This interface extends the interface
50    <type scope="com::sun::star::container">XNameAccess</type> which provides
51    access to existing Gallery themes collection.</p>
52
53    @see com::sun::star::container::XNameAccess
54 */
55interface XGalleryThemeProvider : com::sun::star::container::XNameAccess
56{
57    /** creates a new Gallery theme and adds it to the collection.
58
59        @param ThemeName
60            The name of the Gallery theme to be added to the collection.
61            The name must be unique.
62
63        @returns XGalleryTheme
64            The created theme interface
65
66        @see com::sun::star::container::ElementExistException
67     */
68    XGalleryTheme insertNewByName( [in] string ThemeName )
69        raises ( com::sun::star::container::ElementExistException );
70
71    //-------------------------------------------------------------------------
72
73    /** deletes a Gallery theme from the collection.
74
75        @param ThemeName
76            The name of the Gallery theme to be removed. The
77            theme with the given name must exist.
78
79        @see com::sun::star::container::NoSuchElementException
80    */
81    void removeByName( [in] string ThemeName )
82        raises ( com::sun::star::container::NoSuchElementException );
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91