1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_ui_XUIConfiguration_idl__
29#define __com_sun_star_ui_XUIConfiguration_idl__
30
31#ifndef __com_sun_star_ui_XUIConfigurationListener_idl__
32#include <com/sun/star/ui/XUIConfigurationListener.idl>
33#endif
34
35module com { module sun { module star { module ui {
36
37/** supports to notify other implementations about changes of a user
38    interface configuration manager.
39
40    <p>
41    The <type>XUIConfiguration</type> interface is provided for user
42    interface configuration managers which need to broadcast changes
43    within the container; that means the actions of adding, replacing
44    and removing elements are broadcast to listeners.
45    </p>
46
47    <p>This can be useful for UI to enable/disable some functions without
48    actually accessing the data.</p>
49
50    @since OOo 2.0
51*/
52
53published interface XUIConfiguration : ::com::sun::star::uno::XInterface
54{
55    /** adds the specified listener to receive events when elements are
56        changed, inserted or removed.
57
58        <p>
59        It is suggested to allow multiple registration of the same
60        listener, thus for each time a listener is added, it has to be
61        removed.
62
63        @see XUIConfigurationListener
64        </p>
65    */
66    void addConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
67
68    /** removes the specified listener so it does not receive any events
69        from this user interface configuration manager.
70
71        <p>It is suggested to allow multiple registration of the same
72        listener, thus for each time a listener is added, it has to be
73        removed.
74
75        @see XUIConfigurationListener
76        </p>
77     */
78    void removeConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86