Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: drawing :: framework ::

interface XConfigurationControllerBroadcaster
Description
Manage the set of registered event listeners and the event notification for a configuration controller.

The listeners are called in the order in which they are registered.


Methods' Summary
addConfigurationChangeListener Add a new listener for configuration changes.  
removeConfigurationChangeListener Remove a listener for configuration changes.  
notifyEvent With this method other objects can send events to all the registered listeners.  
Methods' Details
addConfigurationChangeListener
void
addConfigurationChangeListener( [in] XConfigurationChangeListener  xListener,
[in] string  sEventType,
[in] any  aUserData );

Description
Add a new listener for configuration changes.

The listener is notified only for the specified type of configuration changes. When the listener is interested in more than one event type this method has to be called multiple times. Alternatively it can register as universal listener that will be called for all event types. However, this option is provided primarily to support debugging and monitoring.

Parameter xListener
The new listener.
Parameter sEventType
The event type that the listener is interested in. The set of event types is not fixed and there can be no exhaustive list. The empty string is a special value in that the listener will be called for all types of event.
Parameter aUserData
Arbitrary data that is passed to the listener when it is called for the specified event type. When one listener is regisered for more than one event type then different user data objects may be given as well. Supplying unique integer values allows the listener to use a switch statement to distinguish between the different event types.
removeConfigurationChangeListener
void
removeConfigurationChangeListener( [in] XConfigurationChangeListener  xListener );

Description
Remove a listener for configuration changes.
Parameter xListener
The listener that is to be removed.
notifyEvent
void
notifyEvent( [in] ConfigurationChangeEvent  aEvent );

Description
With this method other objects can send events to all the registered listeners.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.