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

interface XDocumentEventBroadcaster
Description
allows to be notified of events happening in an OfficeDocument, and to cause notification of such events.

This interface is the successor of the XEventBroadcaster interface, which should not be used anymore.

Since
OOo 3.1
See also
DocumentEvent

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 behaviour 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 behaviour 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 implementator 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

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.