LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
DispatchDescriptor Struct Referencepublished

describes a feature to be retrieved by a URL that has to be loaded into a specified frame More...

import"DispatchDescriptor.idl";

Public Attributes

com::sun::star::util::URL FeatureURL
 specifies the URL of the resource/function More...
 
string FrameName
 name of the target frame More...
 
long SearchFlags
 describes how the target frame is to be searched More...
 

Detailed Description

describes a feature to be retrieved by a URL that has to be loaded into a specified frame

For a normal dispatch calls all needed parameters are separated. For optimized remote functionality XDispatch::queryDispatches() it's necessary to pack these parameters in a flat structure which can be used in a simple manner.

See also
XDispatchProvider::queryDispatches()

Member Data Documentation

◆ FeatureURL

specifies the URL of the resource/function

Must be a full parsed URL. Use service com::sun::star::util::URLTransformer for that.

See also
com::sun::star::util::URLTransformer

◆ FrameName

string FrameName

name of the target frame

Special targets (e.g. "_blank", "_self") or really existing target names can be used.

See also
XDispatchProvider::queryDispatch()

◆ SearchFlags

long SearchFlags

describes how the target frame is to be searched

This optional parameter is used if FrameName isn't a special target only.

See also
FrameSearchFlag

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