LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XEventAttacher Interface Referencepublished

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

import"XEventAttacher.idl";

Inheritance diagram for XEventAttacher:
XInterface XEventAttacher2

Public Member Functions

com::sun::star::lang::XEventListener attachListener ([in] com::sun::star::uno::XInterface xTarget, [in] com::sun::star::script::XAllListener xAllListener, [in] any aHelper, [in] string aListenerType, [in] string aAddListenerParam) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::IntrospectionException, com::sun::star::script::CannotCreateAdapterException, com::sun::star::lang::ServiceNotRegisteredException )
 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". More...
 
com::sun::star::lang::XEventListener attachSingleEventListener ([in] com::sun::star::uno::XInterface xTarget, [in] com::sun::star::script::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, com::sun::star::script::CannotCreateAdapterException, com::sun::star::lang::ServiceNotRegisteredException )
 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. More...
 
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 )
 removes a listener object as a listener from the given interface. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

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

Member Function Documentation

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".

com::sun::star::lang::XEventListener attachSingleEventListener ( [in] com::sun::star::uno::XInterface  xTarget,
[in] com::sun::star::script::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,
com::sun::star::script::CannotCreateAdapterException,
com::sun::star::lang::ServiceNotRegisteredException
)

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.

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
)

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.


The documentation for this interface was generated from the following file: