ooodev.adapter.ucb.command_processor2_partial module

class ooodev.adapter.ucb.command_processor2_partial.CommandProcessor2Partial(component, interface=com.sun.star.ucb.XCommandProcessor2)[source]

Bases: CommandProcessorPartial

Partial Class XCommandProcessor.

Parameters:

  • component (XCommandProcessor2) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.ucb.XCommandProcessor2)[source]

Constructor

Parameters:

  • component (XCommandProcessor2) – UNO Component that implements com.sun.star.ucb.XCommandProcessor2 interface.

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

Return type:

None

release_command_identifier(cmd_id)[source]

Releases a command identifier obtained through XCommandProcessor.createCommandIdentifier() when it is no longer used.

After this call the command identifier cannot be used any longer in calls to XCommandProcessor.execute() and XCommandProcessor.abort(). (But it can happen that a call to XCommandProcessor.createCommandIdentifier() reuses this identifier.)

Parameters:

cmd_id (int) – A command identifier obtained through XCommandProcessor.createCommandIdentifier(). If the identifier is zero, the request is silently ignored; but if the identifier is invalid (not obtained via XCommandProcessor.createCommandIdentifier() or already handed to XCommandProcessor2.releaseCommandIdentifier() before), the behavior is undefined.

Return type:

None