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