ooodev.adapter.awt.tab_controller_model_partial module

class ooodev.adapter.awt.tab_controller_model_partial.TabControllerModelPartial(component, interface=com.sun.star.awt.XTabControllerModel)[source]

Bases: object

Partial Class XTabControllerModel.

Parameters:

component (XTabControllerModel) –
interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.XTabControllerModel)[source]

Constructor

Parameters:

component (XTabControllerModel) – UNO Component that implements com.sun.star.io.XTabControllerModel interface.
interface (UnoInterface, optional) – The interface to be validated. Defaults to XTabControllerModel.

Return type:

None

get_control_models()[source]

Returns the control models.

Returns:: The controls.
Return type:: tuple[XControlModel]

get_group(idx)[source]

Gets the group for the specified index.

Parameters:: idx (int) – The group index.
Returns:: Results as a tuple of 3 elements. Element at index 1 is a tuple of XControlModel objects. Element 2 is a tuple of str objects. Element at index 2 is a str containing name. A tuple is returned even if the index is not found.
Return type:: tuple

Note

The API documentation shows a return value of void for getGroup(). This is incorrect for python. The return value is a tuple with 3 elements.

See the LibreOffice API documentation for getGroup() for more information.

get_group_by_name(name)[source]

Gets the group for the specified name.

Parameters:: name (str) – The name.
Returns:: Results as a tuple of 2 elements. Element at index 1 is a tuple of XControlModel objects. A tuple is returned even if the index is not found.
Return type:: tuple

Note

The API documentation shows a return value of void for getGroupByName(). This is incorrect for python. The return value is a tuple with 2 elements.

See the LibreOffice API documentation for getGroupByName() for more information.

get_group_control()[source]

Returns the group control.

Returns:: The group control.
Return type:: bool

get_group_count()[source]

Returns the group count.

Returns:: The group count.
Return type:: int

set_control_models(controls)[source]

Sets the control models.

Parameters:: controls (tuple[XControlModel]) – The controls.
Return type:: None

set_group(group, name)[source]

Sets the group.

Parameters:

group (int) – The group.
name (str) – The name.

Return type:

None