ooodev.adapter.frame.layout_manager_events module

class ooodev.adapter.frame.layout_manager_events.LayoutManagerEvents(trigger_args=None, cb=None, listener=None, subscriber=None)

Bases: object

Class for managing Border resize Events.

Parameters:

• trigger_args (GenericArgs | None) –

• cb (ListenerEventCallbackT | None) –

• listener (LayoutManagerListener | None) –

• subscriber (XLayoutManagerEventBroadcaster | None) –

__init__(trigger_args=None, cb=None, listener=None, subscriber=None)

Constructor

Parameters:

• trigger_args (GenericArgs, optional) – Args that are passed to events when they are triggered. This only applies if the listener is not passed.

• cb (ListenerEventCallbackT | None, optional) – Callback that is invoked when an event is added or removed.

• listener (LayoutManagerListener | None, optional) – Listener that is used to manage events.

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

Return type:

None

add_event_layout_event(cb)

Adds a listener for an event.

Event is invoked when a layout manager has made a certain operation.

The callback EventArgs.event_data will contain a dictionary with keys source, layout_event and info. The source will be an com.sun.star.lang.EventObject and info is Any. layout_event will be an enum value of LayoutManagerEventsEnum.

Hint

• LayoutManagerEventsEnum is an enum that can be imported from ooo.dyn.frame.layout_manager_events.

Note

LayoutManagerEventsEnum is an enum that is dynamically generated from LayoutManagerEvents constants.

See also

• API LayoutManagerEvents

Return type:

None

Parameters:

cb (Any) –

add_event_layout_manager_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:

None

Parameters:

cb (Any) –

remove_event_layout_event(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

remove_event_layout_manager_events_disposing(cb)

Removes a listener for an event

Return type:

None

Parameters:

cb (Any) –

property events_listener_layout_manager: LayoutManagerListener

Returns listener

Return type:

LayoutManagerListener

ooodev.adapter.frame.layout_manager_events.on_lazy_cb(source, event)

Callback that is invoked when an event is added or removed.

This method is generally used to add the listener to the component in a lazy manner. This means this callback will only be called once in the lifetime of the component.

Parameters:

• source (Any) – Expected to be an instance of LayoutManagerEvents that is a partial class of a component based class.

• event (ListenerEventArgs) – Event arguments.

Return type:

None

Warning

This method is intended for internal use only.