1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_drawing_framework_XConfigurationControllerBroadcaster_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_drawing_framework_XConfigurationControllerBroadcaster_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module drawing { module framework { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielskipublished interface XConfigurationChangeListener; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski/** Manage the set of registered event listeners and the event notification for a configuration 39*b1cdbd2cSJim Jagielski controller. 40*b1cdbd2cSJim Jagielski <p>The listeners are called in the order in which they are registered.</p> 41*b1cdbd2cSJim Jagielski*/ 42*b1cdbd2cSJim Jagielskipublished interface XConfigurationControllerBroadcaster 43*b1cdbd2cSJim Jagielski{ 44*b1cdbd2cSJim Jagielski /** Add a new listener for configuration changes. 45*b1cdbd2cSJim Jagielski <p>The listener is notified only for the specified type of 46*b1cdbd2cSJim Jagielski configuration changes. When the listener is interested in more than 47*b1cdbd2cSJim Jagielski one event type this method has to be called multiple times. 48*b1cdbd2cSJim Jagielski Alternatively it can register as universal listener that will be 49*b1cdbd2cSJim Jagielski called for all event types. However, this option is provided 50*b1cdbd2cSJim Jagielski primarily to support debugging and monitoring.</p> 51*b1cdbd2cSJim Jagielski @param xListener 52*b1cdbd2cSJim Jagielski The new listener. 53*b1cdbd2cSJim Jagielski @param sEventType 54*b1cdbd2cSJim Jagielski The event type that the listener is interested in. The set of 55*b1cdbd2cSJim Jagielski event types is not fixed and there can be no exhaustive 56*b1cdbd2cSJim Jagielski list. The empty string is a special value in that the listener 57*b1cdbd2cSJim Jagielski will be called for all types of event. 58*b1cdbd2cSJim Jagielski @param aUserData 59*b1cdbd2cSJim Jagielski Arbitrary data that is passed to the listener when it is called 60*b1cdbd2cSJim Jagielski for the specified event type. When one listener is regisered 61*b1cdbd2cSJim Jagielski for more than one event type then different user data objects 62*b1cdbd2cSJim Jagielski may be given as well. Supplying unique integer values allows 63*b1cdbd2cSJim Jagielski the listener to use a switch statement to distinguish between 64*b1cdbd2cSJim Jagielski the different event types. 65*b1cdbd2cSJim Jagielski */ 66*b1cdbd2cSJim Jagielski void addConfigurationChangeListener ( 67*b1cdbd2cSJim Jagielski [in] XConfigurationChangeListener xListener, 68*b1cdbd2cSJim Jagielski [in] string sEventType, 69*b1cdbd2cSJim Jagielski [in] any aUserData); 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** Remove a listener for configuration changes. 72*b1cdbd2cSJim Jagielski @param xListener 73*b1cdbd2cSJim Jagielski The listener that is to be removed. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski void removeConfigurationChangeListener ( 76*b1cdbd2cSJim Jagielski [in] XConfigurationChangeListener xListener); 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski /** With this method other objects can send events to all the registered 79*b1cdbd2cSJim Jagielski listeners. 80*b1cdbd2cSJim Jagielski */ 81*b1cdbd2cSJim Jagielski void notifyEvent ( 82*b1cdbd2cSJim Jagielski [in] ConfigurationChangeEvent aEvent); 83*b1cdbd2cSJim Jagielski}; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski}; }; }; }; }; // ::com::sun::star::drawing::framework 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski#endif 88