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 :: ui ::

unpublished interface XContextChangeEventMultiplexer
Usage Restrictions
not published
Description
Provide a central access point for a group of events. Listeners can be added with a simple restriction on the event source. They are only called for events that originate at the specified source. Event providers can broadcast an event to all interested listeners. The XEventMultiplexer interface is typically implemented as a singleton

Methods' Summary
addContextChangeEventListener Add an event listener that is called only when events are broadcast for the specified event focus.  
removeContextChangeEventListener Remove an event listener for the specified event focus. When the same listener was added for other event foci then these associations remain unmodified.  
removeAllContextChangeEventListeners Remove an event listener for all event foci.  
broadcastContextChangeEvent Call all event listeners that where added for the specified event focus.  
Methods' Details
addContextChangeEventListener
void
addContextChangeEventListener( [in] XContextChangeEventListener  xListener,
[in] ::com::sun::star::uno::XInterface  xEventFocus )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Add an event listener that is called only when events are broadcast for the specified event focus.
Parameter xListener
An empty reference results in an InvalidArgumentException. One listener may be added more than once for different event foci. Adding a listener a second time for the same event focus results in an InvalidArgumentException.
Parameter xEventFocus
An empty reference is a valid value. In this case the registered listener will be called for every event broadcast, regardless of its event focus. The event focus may or may not be the source of the event. A typical example for an event focus is the XController of a view. Using an XController restricts events passed to a listener to events that belong to one view.
Throws
com::sun::star::lang::IllegalArgumentException
removeContextChangeEventListener
void
removeContextChangeEventListener( [in] XContextChangeEventListener  xListener,
[in] ::com::sun::star::uno::XInterface  xEventFocus )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Remove an event listener for the specified event focus. When the same listener was added for other event foci then these associations remain unmodified.
Parameter xListener
An empty reference results in an InvalidArgumentException. When the listener is not registered for the given event focus then an InvalidArgumentException is thrown.
Parameter xEventFocus
The listener is only removed for this event focus. An empty reference is a valid value.
Throws
com::sun::star::lang::IllegalArgumentException
removeAllContextChangeEventListeners
void
removeAllContextChangeEventListeners( [in] XContextChangeEventListener  xListener )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Remove an event listener for all event foci.
Parameter xListener
An empty reference results in an InvalidArgumentException. It is not an error when the listener is not registered for any event focus.
Throws
com::sun::star::lang::IllegalArgumentException
broadcastContextChangeEvent
[oneway] void
broadcastContextChangeEvent( [in] ContextChangeEventObject  aEvent,
[in] ::com::sun::star::uno::XInterface  xEventFocus );

Description
Call all event listeners that where added for the specified event focus.
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.