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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module drawing { module framework {
  21
  22 interface XConfigurationChangeListener;
  23
  24 /** Manage the set of registered event listeners and the event notification for a configuration
  25     controller.
  26     <p>The listeners are called in the order in which they are registered.</p>
  27 */
  28 interface XConfigurationControllerBroadcaster
  29 {
  30     /** Add a new listener for configuration changes.
  31         <p>The listener is notified only for the specified type of
  32         configuration changes.  When the listener is interested in more than
  33         one event type this method has to be called multiple times.
  34         Alternatively it can register as universal listener that will be
  35         called for all event types.  However, this option is provided
  36         primarily to support debugging and monitoring.</p>
  37         @param xListener
  38             The new listener.
  39         @param sEventType
  40             The event type that the listener is interested in.  The set of
  41             event types is not fixed and there can be no exhaustive
  42             list. The empty string is a special value in that the listener
  43             will be called for all types of event.
  44         @param aUserData
  45             Arbitrary data that is passed to the listener when it is called
  46             for the specified event type.  When one listener is registered
  47             for more than one event type then different user data objects
  48             may be given as well.  Supplying unique integer values allows
  49             the listener to use a switch statement to distinguish between
  50             the different event types.
  51     */
  52     void addConfigurationChangeListener (
  53         [in] XConfigurationChangeListener xListener,
  54         [in] string sEventType,
  55         [in] any aUserData);
  56
  57     /** Remove a listener for configuration changes.
  58         @param xListener
  59             The listener that is to be removed.
  60     */
  61     void removeConfigurationChangeListener (
  62         [in] XConfigurationChangeListener xListener);
  63
  64     /** With this method other objects can send events to all the registered
  65         listeners.
  66     */
  67     void notifyEvent (
  68         [in] ConfigurationChangeEvent aEvent);
  69 };
  70
  71 }; }; }; }; }; // ::com::sun::star::drawing::framework
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */