ooodev.adapter.beans.multi_hierarchical_property_set_partial module

class ooodev.adapter.beans.multi_hierarchical_property_set_partial.MultiHierarchicalPropertySetPartial(component, interface=com.sun.star.beans.XMultiHierarchicalPropertySet)[source]

Bases: object

Partial class for XMultiHierarchicalPropertySet.

Parameters:

  • component (XMultiHierarchicalPropertySet) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.beans.XMultiHierarchicalPropertySet)[source]

Constructor

Parameters:

  • component (XMultiHierarchicalPropertySet) – UNO Component that implements com.sun.star.bean.XMultiHierarchicalPropertySet interface.

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

Return type:

None

get_hierarchical_property_set_info()[source]

Gets information about the hierarchy of properties

Return type:

XHierarchicalPropertySetInfo

get_hierarchical_property_values(*names)[source]

The order of the values in the returned sequence will be the same as the order of the names in the argument.

Unknown properties are ignored, in their place NULL will be returned.

Parameters:

names (str) – The names of the properties.

Raises:

com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

Tuple[Any, ...]

set_hierarchical_prop_values(**kwargs)[source]

Sets the values of the properties with the specified nested names.

The values of the properties must change before bound events are fired. The values of constrained properties should change after the vetoable events are fired, if no exception occurs. Unknown properties are ignored.

Similar to set_hierarchical_property_values() but with key, value arguments.

Parameters:

**kwargs – The hierarchical property names and values of the properties.

Raises:

  • com.sun.star.beans.PropertyVetoException – PropertyVetoException

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

  • com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

set_hierarchical_property_values(names, values)[source]

sets the values of the properties with the specified nested names.

The values of the properties must change before bound events are fired. The values of constrained properties should change after the vetoable events are fired, if no exception occurs. Unknown properties are ignored.

Similar to set_hierarchical_prop_values() but with tuple arguments.

Parameters:

  • names (Tuple[str, ...]) – The hierarchical property names of the properties.

  • values (Tuple[Any, ...]) – The values to be set.

Raises:

  • com.sun.star.beans.PropertyVetoException – PropertyVetoException

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

  • com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

ooodev.adapter.beans.multi_hierarchical_property_set_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder