ooodev.adapter.beans.property_with_state_partial module

class ooodev.adapter.beans.property_with_state_partial.PropertyWithStatePartial(component, interface=com.sun.star.beans.XPropertyWithState)[source]

Bases: object

Partial class for XPropertyWithState.

Parameters:

  • component (XPropertyWithState) –

  • interface (UnoInterface | None) –

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

Constructor

Parameters:

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

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

Return type:

None

get_default_as_property()[source]

If no default exists, is not known or is void, then the return value is NULL.

Raises:

com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

XInterface

get_state_as_property()[source]

Gets the state of the property.

Returns:

The state of the property.

Return type:

PropertyState

Hint

  • PropertyState is an enum and can be imported from ooo.dyn.beans.property_state.

set_to_default_as_property()[source]

Sets this to its default value.

The value depends on the implementation of this interface. If this is a bound property, the value changes before the change events are fired. If this is a constrained property, the vetoable event is fired before the property value changes.

Raises:

com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

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

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder