Methods' Summary |
registerScriptEvent |
registers one event for an object identified by its index.
|
registerScriptEvents |
registers several events for an object identified by its index.
|
revokeScriptEvent |
revokes the registration of an event.
|
revokeScriptEvents |
revokes all events which are registered for the given index.
|
insertEntry |
creates an empty entry at the given position.
|
removeEntry |
removes the entry at the given position.
|
getScriptEvents |
|
attach |
attaches all the ScriptEvents which are registered
for the given index to the given object.
|
detach |
detaches all the ScriptEvents from the given object
which are registered at this object for the given index.
|
addScriptListener |
adds an XScriptListener that will be notified when an
event takes place. For that a
ScriptEventDescriptor is registered at and
attached to an object by an XEventAttacherManager.
|
removeScriptListener |
removes a XScriptListener from the listener list.
|
Methods' Details |
registerScriptEvent
- Description
- registers one event for an object identified by its index.
If any object is attached under this index, then this
event is attached automatically.
Exceptions of type
com::sun::star::beans::IntrospectionException and
com::sun::star::script::CannotCreateAdapterException
that can be thrown by methods of XEventAttacher are caught
and ignored.
|
|
registerScriptEvents
- Description
- registers several events for an object identified by its index.
The result is the same as if the method registerScriptEvent()
was called once for each ScriptEventDescriptor
in the sequence.
If any object is attached under this index, then this
event is attached automatically (see attach())
Exceptions of type
com::sun::star::beans::IntrospectionException and
com::sun::star::script::CannotCreateAdapterException
that can be thrown by methods of XEventAttacher are caught
and ignored.
- See also
- registerScriptEvent, attach
|
|
revokeScriptEvent
void |
revokeScriptEvent( |
[in] long |
nIndex, |
| [in] string |
aListenerType, |
| [in] string |
aEventMethod, |
| [in] string |
aRemoveListenerParam ) |
raises( |
::com::sun::star::lang::IllegalArgumentException ); |
- Description
- revokes the registration of an event.
The parameters ListenerType and
EventMethod are equivalent to the first two
members of the ScriptEventDescriptor
used to register events. If this event at this index has
been attached to any object, it is detached automatically
(see attach()).
Exceptions of type
com::sun::star::beans::IntrospectionException and
com::sun::star::script::CannotCreateAdapterException
that can be thrown by methods of XEventAttacher are caught
and ignored.
- See also
- attach
|
|
revokeScriptEvents
- Description
- revokes all events which are registered for the given index.
If the events at this index have been attached to any
object, they are detached automatically.
(see attach()).
- See also
- attach
|
|
insertEntry
- Description
- creates an empty entry at the given position.
The index n of all entries with n >=
nIndex will be increased by one.
|
|
removeEntry
- Description
- removes the entry at the given position.
If any events are registered at this index, they will
be revoked, too. So if the events at this index have been
attached to any object they are detached automatically.
(see attach()).
- See also
- attach
|
|
getScriptEvents
- Returns
- all events registered for the given object index.
- Parameter Index
- an index previously inserted with the method insertEntry.
- Throws
- IllegalArgumentException
if Index is not valid.
|
|
attach
- Description
- attaches all the ScriptEvents which are registered
for the given index to the given object.
Exceptions of type
com::sun::star::beans::IntrospectionException and
com::sun::star::script::CannotCreateAdapterException
that can be thrown by methods of XEventAttacher are caught
and ignored.
|
|
detach
- Description
- detaches all the ScriptEvents from the given object
which are registered at this object for the given index.
Exceptions of type
com::sun::star::beans::IntrospectionException and
com::sun::star::script::CannotCreateAdapterException
that can be thrown by methods of XEventAttacher are caught
and ignored.
|
|
addScriptListener
- Description
- adds an XScriptListener that will be notified when an
event takes place. For that a
ScriptEventDescriptor is registered at and
attached to an object by an XEventAttacherManager.
It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
- See also
- removeScriptListener
|
|
removeScriptListener
- Description
- removes a XScriptListener from the listener list.
Nothing happens if the listener is not registered.
It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
- See also
- addScriptListener
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.