ooodev.adapter.frame.frame_action_listener module

class ooodev.adapter.frame.frame_action_listener.FrameActionListener(trigger_args=None, subscriber=None)[source]

Bases: AdapterBase, XFrameActionListener

Has to be provided if an object wants to receive events when several things happen to components within frames of the desktop frame tree.

E.g., you can receive events of instantiation/destruction and activation/deactivation of components.

See also

API XFrameActionListener

Parameters:

  • args (Any) –

  • kwargs (Any) –

Return type:

Any

__init__(trigger_args=None, subscriber=None)[source]

Constructor

Parameters:

  • trigger_args (GenericArgs, Optional) – Args that are passed to events when they are triggered.

  • subscriber (XFrame, optional) – An UNO object that implements the XFrame interface. If passed in then this listener instance is automatically added to it.

Return type:

None

disposing(event)[source]

Gets called when the broadcaster is about to be disposed.

All listeners and all other objects, which reference the broadcaster should release the reference to the source. No method should be invoked anymore on this object ( including XComponent.removeEventListener() ).

This method is called for every listener registration of derived listener interfaced, not only for registrations at XComponent.

Return type:

None

Parameters:

event (com.sun.star.lang.EventObject) –

frameAction(event)[source]

Is invoked whenever any action occurs to a component within a frame.

Return type:

None

Parameters:

event (com.sun.star.frame.FrameActionEvent) –