ooodev.adapter.view.form_layer_access_partial module

class ooodev.adapter.view.form_layer_access_partial.FormLayerAccessPartial(component, interface=com.sun.star.view.XFormLayerAccess)

Bases: ControlAccessPartial

Partial class for XFormLayerAccess.

Parameters:

• component (XFormLayerAccess) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.view.XFormLayerAccess)

Constructor

Parameters:

• component (XFormLayerAccess) – UNO Component that implements com.sun.star.view.XFormLayerAccess interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XFormLayerAccess.

Return type:

None

get_form_controller(form)

Gets the FormControllerComp instance which operates on a given form.

A form controller is a component which controls the user interaction with the form layer, as long as the form is not in design mode.

Return type:

FormControllerComp

Parameters:

form (com.sun.star.form.XForm) –

is_form_design_mode()

Gets whether the view’s form layer is currently in design or alive mode

Note: This is a convenience method. In the user interface, the design mode is coupled with the .uno:SwitchControlDesignMode feature (see com.sun.star.frame.XDispatchProvider), and asking for the current mode is the same as asking for the state of this feature.

Return type:

bool

set_form_design_mode(design_mode)

Sets whether the view’s form layer is currently in design or alive mode

Note

This is a convenience method. In the user interface, the design mode is coupled with the .uno:SwitchControlDesignMode feature (see com.sun.star.frame.XDispatchProvider), and changing the current mode is the same as dispatching this feature URL.

Return type:

None

Parameters:

design_mode (bool) –