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_XUIConfiguration_idl__
25#define __com_sun_star_ui_XUIConfiguration_idl__
26
27#ifndef __com_sun_star_ui_XUIConfigurationListener_idl__
28#include <com/sun/star/ui/XUIConfigurationListener.idl>
29#endif
30
31module com { module sun { module star { module ui {
32
33/** supports to notify other implementations about changes of a user
34    interface configuration manager.
35
36    <p>
37    The <type>XUIConfiguration</type> interface is provided for user
38    interface configuration managers which need to broadcast changes
39    within the container; that means the actions of adding, replacing
40    and removing elements are broadcast to listeners.
41    </p>
42
43    <p>This can be useful for UI to enable/disable some functions without
44    actually accessing the data.</p>
45
46    @since OOo 2.0
47*/
48
49published interface XUIConfiguration : ::com::sun::star::uno::XInterface
50{
51    /** adds the specified listener to receive events when elements are
52        changed, inserted or removed.
53
54        <p>
55        It is suggested to allow multiple registration of the same
56        listener, thus for each time a listener is added, it has to be
57        removed.
58
59        @see XUIConfigurationListener
60        </p>
61    */
62    void addConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
63
64    /** removes the specified listener so it does not receive any events
65        from this user interface configuration manager.
66
67        <p>It is suggested to allow multiple registration of the same
68        listener, thus for each time a listener is added, it has to be
69        removed.
70
71        @see XUIConfigurationListener
72        </p>
73     */
74    void removeConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
75};
76
77//=============================================================================
78
79}; }; }; };
80
81#endif
82