ooodev.adapter.document.action_lockable_partial module

class ooodev.adapter.document.action_lockable_partial.ActionLockablePartial(component, interface=com.sun.star.document.XActionLockable)

Bases: object

Partial class for XActionLockable.

Parameters:

• component (XActionLockable) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.document.XActionLockable)

Constructor

Parameters:

• component (XActionLockable) – UNO Component that implements com.sun.star.document.XActionLockable interface.

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

Return type:

None

add_action_lock()

increments the lock count of the object by one.

Return type:

None

is_action_locked()

Return type:

bool

remove_action_lock()

decrements the lock count of the object by one.

Return type:

None

reset_action_locks()

resets the locking level.

This method is used for debugging purposes. The debugging environment of a programming language can reset the locks to allow refreshing of the view if a breakpoint is reached or step execution is used.

Return type:

int

set_action_locks(lock)

sets the locking level.

This method is used for debugging purposes. The programming environment can restore the locking after a break of a debug session.

Return type:

None

Parameters:

lock (int) –