ooodev.adapter.awt.tab.tab_page_container_partial module

class ooodev.adapter.awt.tab.tab_page_container_partial.TabPageContainerPartial(component, interface=com.sun.star.awt.tab.XTabPageContainer)

Bases: object

Partial class for XTabPageContainer.

Parameters:

• component (XTabPageContainer) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.tab.XTabPageContainer)

Constructor

Parameters:

• component (XTabPageContainer) – UNO Component that implements com.sun.star.awt.tab.XTabPageContainer interface.

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

Return type:

None

add_tab_page_container_listener(listener)

Adds a listener for the TabPageActiveEvent posted after the tab page was activated.

Return type:

None

Parameters:

listener (com.sun.star.awt.tab.XTabPageContainerListener) –

get_tab_page(tab_page_index)

Returns tab page for the given index.

Return type:

UnoControlTabPageComp

Parameters:

tab_page_index (int) –

get_tab_page_by_id(tab_page_id)

Returns tab page for the given ID.

Return type:

UnoControlTabPageComp

Parameters:

tab_page_id (int) –

get_tab_page_count()

Gets the number of tab pages.

Return type:

int

is_tab_page_active(tab_page_index)

Checks whether a tab page is activated.

Return type:

bool

Parameters:

tab_page_index (int) –

remove_tab_page_container_listener(listener)

Removes a listener previously added with addTabPageListener().

Return type:

None

Parameters:

listener (com.sun.star.awt.tab.XTabPageContainerListener) –

property active_tab_page_id: int

Specifies the ID of the current active tab page.

Return type:

int