offapi/com/sun/star/drawing/framework/XConfigurationControllerBroadcaster.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XConfigurationControllerBroadcaster.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_drawing_framework_XConfigurationControllerBroadcaster_idl__
  32 #define __com_sun_star_drawing_framework_XConfigurationControllerBroadcaster_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
  38 #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
  39 #endif
  40
  41 module com { module sun { module star { module drawing { module framework {
  42
  43 interface XConfigurationChangeListener;
  44
  45 /** Manage the set of registered event listeners and the event notification for a configuration
  46     controller.
  47     <p>The listeners are called in the order in which they are registered.</p>
  48 */
  49 interface XConfigurationControllerBroadcaster
  50 {
  51     /** Add a new listener for configuration changes.
  52         <p>The listener is notified only for the specified type of
  53         configuration changes.  When the listener is interested in more than
  54         one event type this method has to be called multiple times.
  55         Alternatively it can register as universal listener that will be
  56         called for all event types.  However, this option is provided
  57         primarily to support debugging and monitoring.</p>
  58         @param xListener
  59             The new listener.
  60         @param sEventType
  61             The event type that the listener is interested in.  The set of
  62             event types is not fixed and there can be no exhaustive
  63             list. The empty string is a special value in that the listener
  64             will be called for all types of event.
  65         @param aUserData
  66             Arbitrary data that is passed to the listener when it is called
  67             for the specified event type.  When one listener is regisered
  68             for more than one event type then different user data objects
  69             may be given as well.  Supplying unique integer values allows
  70             the listener to use a switch statement to distinguish between
  71             the different event types.
  72     */
  73     void addConfigurationChangeListener (
  74         [in] XConfigurationChangeListener xListener,
  75         [in] string sEventType,
  76         [in] any aUserData);
  77
  78     /** Remove a listener for configuration changes.
  79         @param xListener
  80             The listener that is to be removed.
  81     */
  82     void removeConfigurationChangeListener (
  83         [in] XConfigurationChangeListener xListener);
  84
  85     /** With this method other objects can send events to all the registered
  86         listeners.
  87     */
  88     void notifyEvent (
  89         [in] ConfigurationChangeEvent aEvent);
  90 };
  91
  92 }; }; }; }; }; // ::com::sun::star::drawing::framework
  93
  94 #endif