ooodev.adapter.frame.dispatch_provider_partial module
- class ooodev.adapter.frame.dispatch_provider_partial.DispatchProviderPartial(component, interface=com.sun.star.frame.XDispatchProvider)[source]
Bases:
object
Partial class for XDispatchProvider.
- Parameters:
component (XDispatchProvider) –
interface (UnoInterface | None) –
- __init__(component, interface=com.sun.star.frame.XDispatchProvider)[source]
Constructor
- Parameters:
component (XDispatchProvider) – UNO Component that implements
com.sun.star.frame.XDispatchProvider
interface.interface (UnoInterface, optional) – The interface to be validated. Defaults to
XDispatchProvider
.
- Return type:
None
- query_dispatch(url, target_frame_name, search_flags=FrameSearchFlagEnum.AUTO)[source]
Returns a dispatch object for the specified URL.
- Parameters:
url (URL) – Specifies the feature which should be supported by returned dispatch object.
target_frame_name (str) – Specifies the frame which should be the target for this request.
search_flags (int, FrameSearchFlagEnum, optional) – Optional search parameter for finding the frame if no special TargetFrameName was used.
- Returns:
the dispatch object which provides queried functionality or None if no dispatch object is available.
- Return type:
XDispatch
- query_dispatches(requests)[source]
Returns a list of dispatch objects for the specified URLs.
Actually this method is redundant to
query_dispatch()
to avoid multiple remote calls.- Parameters:
requests (Tuple[DispatchDescriptor, ...]) – Tuple of dispatch requests
- Returns:
multiple dispatch interfaces for the specified descriptors at once
- Return type:
Tuple[XDispatch | None, …]