LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XDispatchProvider Interface Referencepublished

provides XDispatch interfaces for certain functions which are useful at the UI. More...

import"XDispatchProvider.idl";

Inheritance diagram for XDispatchProvider:
XInterface ModuleDispatcher FormControllerDispatcher Controller DispatchProvider PopupMenuController ProtocolHandler XAppDispatchProvider XDesktop2 XDispatchProviderInterceptor XFrame2 XObjectInspector DataSourceBrowser ModuleDispatcher

Public Member Functions

XDispatch queryDispatch ([in] com::sun::star::util::URL URL, [in] string TargetFrameName, [in] long SearchFlags)
 searches for an XDispatch for the specified URL within the specified target frame. More...
 
sequence< XDispatchqueryDispatches ([in] sequence< DispatchDescriptor > Requests)
 actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides XDispatch interfaces for certain functions which are useful at the UI.

See also
XDispatch
Developers Guide
WritingUNO - Implementation
OfficeDev - Dispatch Framework

Member Function Documentation

XDispatch queryDispatch ( [in] com::sun::star::util::URL  URL,
[in] string  TargetFrameName,
[in] long  SearchFlags 
)

searches for an XDispatch for the specified URL within the specified target frame.

Parameters
URLdescribe the feature which should be supported by returned dispatch object
TargetFrameNamespecify the frame which should be the target for this request
SearchFlagsoptional search parameter for finding the frame if no special TargetFrameName was used
Returns
the dispatch object which provides queried functionality
or NULL if no dispatch object is available
See also
XFrame::findFrame()
XDispatchProvider::queryDispatches()
sequence< XDispatch > queryDispatches ( [in] sequence< DispatchDescriptor Requests)

actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls.

Parameters
Requestslist of dispatch requests
Returns
multiple dispatch interfaces for the specified descriptors at once

It's not allowed to pack it - because every request must match to his real result. Means: don't delete NULL entries inside this list.


The documentation for this interface was generated from the following file: