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