ooodev.adapter.form.runtime.form_controller_partial module

class ooodev.adapter.form.runtime.form_controller_partial.FormControllerPartial(component, interface=com.sun.star.form.runtime.XFormController)[source]

Bases: ChildPartial, IndexAccessPartial, EnumerationAccessPartial, ComponentPartial, ModifyBroadcasterPartial, ConfirmDeleteBroadcasterPartial, SQLErrorBroadcasterPartial, RowSetApproveBroadcasterPartial, DatabaseParameterBroadcaster2Partial, ModeSelectorPartial, FilterControllerPartial

Partial Class for XFormController.

This interface does not really provide an own functionality, it is only for easier runtime identification of form components.

__init__(component, interface=com.sun.star.form.runtime.XFormController)[source]

Constructor

Parameters:

component (XFormController) – UNO Component that implements com.sun.star.form.runtime.XFormController.
interface (UnoInterface, optional) – The interface to be validated. Defaults to None.

Return type:

None

add_activate_listener(listener)[source]

Adds the specified listener to receive notifications whenever the activation state of the controller changes.

Return type:: None
Parameters:: listener (com.sun.star.form.XFormControllerListener) –

add_child_controller(child_controller)[source]

adds a controller to the list of child controllers

Raises:: com.sun.star.lang.IllegalArgumentException – IllegalArgumentException
Return type:: None
Parameters:: child_controller (com.sun.star.form.runtime.XFormController) –

remove_activate_listener(listener)[source]

removes the specified listener from the list of components to receive notifications whenever the activation state of the controller changes.

Return type:: None
Parameters:: listener (com.sun.star.form.XFormControllerListener) –

property context: com.sun.star.form.runtime.XFormControllerContext

Gets/Sets - allows to delegate certain tasks to the context of the form controller

Return type:: XFormControllerContext

property current_control: com.sun.star.awt.XControl

Gets access to the currently active control.

Return type:: XControl

property form_operations: com.sun.star.form.runtime.XFormOperations

Gets the instance which is used to implement operations on the form which the controller works for.

This instance can be used, for instance, to determine the current state of certain form features.

Return type:: XFormOperations

property interaction_handler: com.sun.star.task.XInteractionHandler

Gets/Sets - used (if not None) for user interactions triggered by the form controller.

Return type:: XInteractionHandler