ooodev.adapter.frame.dispatch_information_provider_partial module

class ooodev.adapter.frame.dispatch_information_provider_partial.DispatchInformationProviderPartial(component, interface=com.sun.star.frame.XDispatchInformationProvider)[source]

Bases: object

Partial class for XDispatchInformationProvider.

Parameters:

  • component (XDispatchInformationProvider) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.frame.XDispatchInformationProvider)[source]

Constructor

Parameters:

  • component (XDispatchInformationProvider) – UNO Component that implements com.sun.star.frame.XDispatchInformationProvider interface.

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

Return type:

None

get_configurable_dispatch_information(command_group)[source]

returns additional information about supported commands of a given command group.

Return type:

Tuple[DispatchInformation, ...]

Parameters:

command_group (int) –

get_supported_command_groups()[source]

Returns all supported command groups.

Returns:

Supported command groups.

Return type:

Tuple[CommandGroupEnum, …]

Note

If you want to get the groups as a tuple of integers call component.getSupportedCommandGroups().

Hint

  • CommandGroupEnum can be imported from ooo.dyn.frame.command_group

ooodev.adapter.frame.dispatch_information_provider_partial.get_builder(component)[source]

Get the builder for the component.

Parameters:

component (Any) – The component.

Returns:

Builder instance.

Return type:

DefaultBuilder