ooodev.adapter.frame.controller2_partial module

class ooodev.adapter.frame.controller2_partial.Controller2Partial(component, interface=com.sun.star.frame.XController2)[source]

Bases: ControllerPartial

Partial class for XController2.

Parameters:

  • component (XController2) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.frame.XController2)[source]

Constructor

Parameters:

  • component (XController2) – UNO Component that implements com.sun.star.frame.XController2 interface.

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

Return type:

None

get_sidebar()[source]

Get the sidebar if exists

since

LibreOffice 5.1

Return type:

XSidebarProvider

property component_window: WindowComp

denotes the “root window” of the controller.

If the controller is plugged into a frame, this window acts as the frame’s ComponentWindow.

Return type:

WindowComp

property creation_arguments: Tuple[PropertyValue, ...]

Denotes the arguments used to create the instance.

Usually, controllers are created via XModel2.createViewController(), where the caller can pass not only a controller name, but also arguments parameterizing the to-be-created instance. Those arguments used at creation time can subsequently be retrieved using the CreationArguments member.

Return type:

Tuple[PropertyValue, ...]

property view_controller_name: str

specifies the view name of the controller.

A view name is a logical name, which can be used to create views of the same type. The name is meaningful only in conjunction with XModel2.createViewController()

Return type:

str