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_drawing_framework_XConfigurationControllerBroadcaster_idl__
29#define __com_sun_star_drawing_framework_XConfigurationControllerBroadcaster_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34#ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
35#include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
36#endif
37
38module com { module sun { module star { module drawing { module framework {
39
40published interface XConfigurationChangeListener;
41
42/** Manage the set of registered event listeners and the event notification for a configuration
43    controller.
44    <p>The listeners are called in the order in which they are registered.</p>
45*/
46published interface XConfigurationControllerBroadcaster
47{
48    /** Add a new listener for configuration changes.
49        <p>The listener is notified only for the specified type of
50        configuration changes.  When the listener is interested in more than
51        one event type this method has to be called multiple times.
52        Alternatively it can register as universal listener that will be
53        called for all event types.  However, this option is provided
54        primarily to support debugging and monitoring.</p>
55        @param xListener
56            The new listener.
57        @param sEventType
58            The event type that the listener is interested in.  The set of
59            event types is not fixed and there can be no exhaustive
60            list. The empty string is a special value in that the listener
61            will be called for all types of event.
62        @param aUserData
63            Arbitrary data that is passed to the listener when it is called
64            for the specified event type.  When one listener is regisered
65            for more than one event type then different user data objects
66            may be given as well.  Supplying unique integer values allows
67            the listener to use a switch statement to distinguish between
68            the different event types.
69    */
70    void addConfigurationChangeListener (
71        [in] XConfigurationChangeListener xListener,
72        [in] string sEventType,
73        [in] any aUserData);
74
75    /** Remove a listener for configuration changes.
76        @param xListener
77            The listener that is to be removed.
78    */
79    void removeConfigurationChangeListener (
80        [in] XConfigurationChangeListener xListener);
81
82    /** With this method other objects can send events to all the registered
83        listeners.
84    */
85    void notifyEvent (
86        [in] ConfigurationChangeEvent aEvent);
87};
88
89}; }; }; }; }; // ::com::sun::star::drawing::framework
90
91#endif
92