LibreOffice
LibreOffice 5.0 SDK API Reference
|
import "XDesktop2.idl";
Exported Interfaces | |
interface | XDispatchProvider |
provides access to dispatchers for the frame. More... | |
interface | XDispatchProviderInterception |
supports interception mechanism for dispatched URLs More... | |
interface | XFramesSupplier |
provides access to sub frames within this frame More... | |
interface | XDesktop |
regulate life time of desktop environment and support high level access to components of sub frame tree More... | |
interface | XComponentLoader |
supports simple API for loading components into the frame environment More... | |
Additional Inherited Members | |
![]() | |
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< XDispatch > | queryDispatches ([in] sequence< DispatchDescriptor > Requests) |
actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls. More... | |
![]() | |
void | registerDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor) |
registers an XDispatchProviderInterceptor, which will become the first interceptor in the chain of registered interceptors. More... | |
void | releaseDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor) |
removes an XDispatchProviderInterceptor which was previously registered More... | |
![]() | |
XFrames | getFrames () |
provides access to this container and to all other XFramesSupplier which are available from this node of frame tree More... | |
XFrame | getActiveFrame () |
gets the current active frame of this container (not of any other available supplier) More... | |
void | setActiveFrame ([in] XFrame Frame) |
is called on activation of a direct sub-frame. More... | |
![]() | |
boolean | terminate () |
tries to terminate the desktop. More... | |
void | addTerminateListener ([in] XTerminateListener Listener) |
registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates. More... | |
void | removeTerminateListener ([in] XTerminateListener Listener) |
unregisters an event listener for termination events. More... | |
com::sun::star::container::XEnumerationAccess | getComponents () |
provides read access to collection of all currently loaded components inside the frame tree More... | |
com::sun::star::lang::XComponent | getCurrentComponent () |
provides read access to the component inside the tree which has the UI focus More... | |
XFrame | getCurrentFrame () |
provides read access to the frame which contains the current component More... | |
![]() | |
com::sun::star::lang::XComponent | loadComponentFromURL ([in] string URL,[in] string TargetFrameName,[in] long SearchFlags,[in] sequence< com::sun::star::beans::PropertyValue > Arguments) raises ( com::sun::star::io::IOException, com::sun::star::lang::IllegalArgumentException ) |
loads a component specified by an URL into the specified new or existing frame. More... | |
interface XComponentLoader |
supports simple API for loading components into the frame environment
interface XDesktop |
regulate life time of desktop environment and support high level access to components of sub frame tree
interface XDispatchProvider |
provides access to dispatchers for the frame.
What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(), and how the returned dispatcher handles dispatches is completely implementation dependent (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to XDispatchProvider::queryDispatch(). Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.
Common special targets include:
interface XDispatchProviderInterception |
supports interception mechanism for dispatched URLs
Registered objects can intercept, suppress or reroute dispatched URLs. If they support another interface too (XInterceptorInfo) it's possible to perform it by directly calling of right interceptor without using list of all registered ones.
interface XFramesSupplier |
provides access to sub frames within this frame