summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/gallery/XGalleryThemeProvider.idl
blob: 5156633585220e328a7935243fa83b4f6fd8b148 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_gallery_XGalleryThemeProvider_idl__
#define __com_sun_star_gallery_XGalleryThemeProvider_idl__

#include <com/sun/star/gallery/XGalleryTheme.idl>
#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/container/ElementExistException.idl>
#include <com/sun/star/container/NoSuchElementException.idl>


module com {  module sun {  module star {  module gallery {


/** provides access to the Gallery themes. It also allows inserting and
    removing of Gallery themes by name.

    <p>This interface extends the interface
    com::sun::star::container::XNameAccess which provides
    access to existing Gallery themes collection.</p>

    @see com::sun::star::container::XNameAccess
 */
interface XGalleryThemeProvider : com::sun::star::container::XNameAccess
{
    /** creates a new Gallery theme and adds it to the collection.

        @param ThemeName
            The name of the Gallery theme to be added to the collection.
            The name must be unique.

        @returns XGalleryTheme
            The created theme interface

        @see com::sun::star::container::ElementExistException
     */
    XGalleryTheme insertNewByName( [in] string ThemeName )
        raises ( com::sun::star::container::ElementExistException );


    /** deletes a Gallery theme from the collection.

        @param ThemeName
            The name of the Gallery theme to be removed. The
            theme with the given name must exist.

        @see com::sun::star::container::NoSuchElementException
    */
    void removeByName( [in] string ThemeName )
        raises ( com::sun::star::container::NoSuchElementException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */