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_ui_XModuleUIConfigurationManager_idl__
25#define __com_sun_star_ui_XModuleUIConfigurationManager_idl__
26
27#ifndef __com_sun_star_container_XIndexContainer_idl__
28#include <com/sun/star/container/XIndexContainer.idl>
29#endif
30
31#ifndef __com_sun_star_container_XIndexAccess_idl__
32#include <com/sun/star/container/XIndexAccess.idl>
33#endif
34
35#ifndef __com_sun_star_container_NoSuchElementException_idl__
36#include <com/sun/star/container/NoSuchElementException.idl>
37#endif
38
39#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
40#include <com/sun/star/lang/IllegalArgumentException.idl>
41#endif
42
43#ifndef __com_sun_star_lang_IllegalAccessException_idl__
44#include <com/sun/star/lang/IllegalAccessException.idl>
45#endif
46
47module com { module sun { module star { module ui {
48
49/** specifies specific functions of a module based user interface
50    configuration manager interface.
51
52    <p>
53    A module user interface configuration manager supports, unlike a
54    document based ui configration manager, two layers of configuration
55    settings data:<br/>
56    1. Layer: A module default user interface configuration which
57              describe all user interface elements settings that are
58              used by OpenOffice. It is not possible to insert, remove
59              or changeelements settings in this layer through the
60              interfaces.</br>
61    2. Layer: A module user interface configuration which only contains
62              customized user interface elements and user-defined ones.
63              All changes on user interface element settings are done on
64              this layer. This layer is the same as the document ui
65              configuration manager uses.</br>
66    </p>
67
68    @since OpenOffice 2.0
69*/
70
71interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface
72{
73    /** determine if the settings of a user interface element is part
74        of the default layer of the user interface configuration manager.
75
76        @param ResourceURL
77            a resource URL which identifies the user interface element. A
78            resourcce URL must meet the following syntax:
79            "private:resource/$type/$name. It is only allowed to use ascii
80            characters for type and name.
81
82        @return
83            <TRUE/> if settings have been found in the default layer,
84            otherwise <FALSE/>.
85    */
86    boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException );
87
88    /** retrieves the settings from the default layer of the user interface
89        configuration manager if it has a default layer.
90
91        @param ResourceURL
92            a resource URL which identifies the user interface element. A
93            resourcce URL must meet the following syntax:
94            "private:resource/$type/$name. It is only allowed to use ascii
95            characters for type and name.
96
97        @return
98            <TRUE/> if default settings have been found in the default layer,
99            otherwise <FALSE/>.
100    */
101    ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException );
102
103};
104
105//=============================================================================
106
107}; }; }; };
108
109#endif
110