ooodev.adapter.beans.multi_property_states_partial module

class ooodev.adapter.beans.multi_property_states_partial.MultiPropertyStatesPartial(component, interface=com.sun.star.beans.XMultiPropertyStates)[source]

Bases: object

Partial class for XMultiPropertyStates.

Parameters:

  • component (XMultiPropertyStates) –

  • interface (UnoInterface | None) –

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

Constructor

Parameters:

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

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

Return type:

None

get_property_defaults(*names)[source]

If no default exists, is not known, or is void, then the return type at the corresponding position in the sequence returned is void.

Parameters:

names (str) – One or more names of the properties.

Raises:

  • com.sun.star.beans.UnknownPropertyException – UnknownPropertyException

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

Returns:

The default values of the properties.

Return type:

Tuple[Any, …]

get_property_states(*names)[source]

The order of the states is correlating to the order of the given property names.

Parameters:

names (str) – One or more names of the properties.

Raises:

com.sun.star.beans.UnknownPropertyException – UnknownPropertyException

Returns:

The states of the properties.

Return type:

Tuple[PropertyState, …]

set_all_properties_to_default()[source]

Sets all properties to their default values.

Each value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value.

Return type:

None

set_properties_to_default(*names)[source]

Sets the specified properties to their default values.

Each value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value.

Parameters:

names (str) – One or more names of the properties.

Raises:

com.sun.star.beans.UnknownPropertyException – UnknownPropertyException

Return type:

None

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

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder