ooodev.adapter.util.changes_batch_partial module

class ooodev.adapter.util.changes_batch_partial.ChangesBatchPartial(component, interface=com.sun.star.util.XChangesBatch)[source]

Bases: object

Partial Class XChangesBatch.

Parameters:

  • component (XChangesBatch) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.util.XChangesBatch)[source]

Constructor

Parameters:

  • component (XChangesBatch) – UNO Component that implements com.sun.star.util.XChangesBatch interface.

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

Return type:

None

commit_changes()[source]

commits any pending changes.

The exact action depends on the concrete service.

Raises:

com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

get_pending_changes()[source]

queries for any pending changes that can be committed.

Return type:

Tuple[ElementChange, ...]

has_pending_changes()[source]

checks whether this object has any pending changes that can be committed.

Return type:

bool

ooodev.adapter.util.changes_batch_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder