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

interface XEventAttacher
Description
makes it possible to attach script events given by a sequence of ScriptEventDescriptor structures to a given interface.

Methods' Summary
attachListener registers the given "AllListener" object as a listener at the given interface by creating a suitable listener adapter and calling the "addListener" method corresponding to the "ListenerType".  
attachSingleEventListener registers an object as a listener at the given interface by creating a suitable listener adapter and calling the method which corresponds to the listener type.  
removeListener removes a listener object as a listener from the given interface.  
Methods' Details
attachListener
::com::sun::star::lang::XEventListener
attachListener( [in] ::com::sun::star::uno::XInterface  xTarget,
[in] XAllListener  xAllListener,
[in] any  aHelper,
[in] string  aListenerType,
[in] string  aAddListenerParam )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::beans::IntrospectionException,
CannotCreateAdapterException,
::com::sun::star::lang::ServiceNotRegisteredException );

Description
registers the given "AllListener" object as a listener at the given interface by creating a suitable listener adapter and calling the "addListener" method corresponding to the "ListenerType".
attachSingleEventListener
::com::sun::star::lang::XEventListener
attachSingleEventListener( [in] ::com::sun::star::uno::XInterface  xTarget,
[in] XAllListener  xAllListener,
[in] any  aHelper,
[in] string  aListenerType,
[in] string  aAddListenerParam,
[in] string  aEventMethod )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::beans::IntrospectionException,
CannotCreateAdapterException,
::com::sun::star::lang::ServiceNotRegisteredException );

Description
registers an object as a listener at the given interface by creating a suitable listener adapter and calling the method which corresponds to the listener type.

Only the event corresponding to the given event method will be delegated to xAllListener.

removeListener
void
removeListener( [in] ::com::sun::star::uno::XInterface  xTarget,
[in] string  aListenerType,
[in] string  aRemoveListenerParam,
[in] ::com::sun::star::lang::XEventListener  xToRemoveListener )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::beans::IntrospectionException );

Description
removes a listener object as a listener from the given interface.

This method can and should be used as a contrary method to the two attach methods.

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.