ooodev.adapter.container.hierarchical_name_partial module

class ooodev.adapter.container.hierarchical_name_partial.HierarchicalNamePartial(component, interface=com.sun.star.container.XHierarchicalName)

Bases: object

Partial class for XHierarchicalName.

Parameters:

• component (XHierarchicalName) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.container.XHierarchicalName)

Constructor

Parameters:

• component (XHierarchicalName) – UNO Component that implements com.sun.star.container.XHierarchicalName interface.

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

Return type:

None

compose_hierarchical_name(relative_name)

builds the hierarchical name of an object, given a relative name

Can be used to find the name of a descendant object in the hierarchy without actually accessing it.

Raises:

• com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

• com.sun.star.lang.NoSupportException – NoSupportException

Return type:

str

Parameters:

relative_name (str) –

get_hierarchical_name()

returns the hierarchical name of the object within its parent container

Return type:

str

ooodev.adapter.container.hierarchical_name_partial.get_builder(component)

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder