:: com :: sun :: star :: document ::

interface XDocumentEventBroadcaster

Methods' Summary
addDocumentEventListener registers a listener which is notified about document events  
removeDocumentEventListener revokes a listener which has previously been registered to be notified about document events.  
notifyDocumentEvent causes the broadcaster to notify all registered listeners of the given event  
Methods' Details
addDocumentEventListener
void
addDocumentEventListener( [in] XDocumentEventListener  Listener );

Description
registers a listener which is notified about document events
Parameter Listener
the listener to register. The behavior of the method is undefined this listener is `NULL`.
removeDocumentEventListener
void
removeDocumentEventListener( [in] XDocumentEventListener  Listener );

Description
revokes a listener which has previously been registered to be notified about document events.
Parameter Listener
the listener to revoke. The behavior of the method is undefined this listener is `NULL`.
notifyDocumentEvent
void
notifyDocumentEvent( [in] string  EventName,
[in] ::com::sun::star::frame::XController2  ViewController,
[in] any  Supplement )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::NoSupportException );

Description
causes the broadcaster to notify all registered listeners of the given event

The method will create a DocumentEvent instance with the given parameters, and fill in the Source member (denoting the broadcaster) as appropriate.

Whether the actual notification happens synchronously or asynchronously is up to the implementor of this method. However, implementations are encouraged to specify this, for the list of supported event types, in their service contract.

Implementations might also decide to limit the list of allowed events (means event names) at their own discretion. Again, in this case they're encouraged to document this in their service contract.

Parameter EventName
the name of the event to be notified.
Parameter ViewController
the view/controller which the event applies to. May be `NULL`
Parameter Supplement
supplemental information related to the event.
Throws
::com::sun::star::lang::IllegalArgumentException if EventName is empty, or if EventName is not supported by the document implementation.
Throws
::com::sun::star::lang::NoSupportException if the broadcaster implementation does not supported broadcasting events induced externally. This is usually used for components which multiplex events from multiple sources, and thus would be unable to fill in the Source member of the DocumentEvent instance.
Top of Page