Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: document ::
unpublished | interface XDocumentEventBroadcaster |
Usage Restrictions not published 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 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

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.