LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
XDesktop2 Interface Referencepublished

`import "XDesktop2.idl";`

Inheritance diagram for XDesktop2:

## Exported Interfaces
interface | XDispatchProvider
| provides access to dispatchers for the frame.
interface | XDispatchProviderInterception
| supports interception mechanism for dispatched URLs
interface | XFramesSupplier
| provides access to sub frames within this frame
interface | XDesktop
| regulate life time of desktop environment and support high level access to components of sub frame tree
interface | XComponentLoader
| supports simple API for loading components into the frame environment

## Additional Inherited Members
Public Member Functions inherited from XDispatchProvider
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.
sequence< XDispatch > | queryDispatches ([in] sequence< DispatchDescriptor > Requests)
| actually this method is redundant to XDispatchProvider::queryDispatch() to avoid multiple remote calls.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.
Public Member Functions inherited from XDispatchProviderInterception
void | registerDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor)
| registers an XDispatchProviderInterceptor, which will become the first interceptor in the chain of registered interceptors.
void | releaseDispatchProviderInterceptor ([in] XDispatchProviderInterceptor Interceptor)
| removes an XDispatchProviderInterceptor which was previously registered
Public Member Functions inherited from XFramesSupplier
XFrames | getFrames ()
| provides access to this container and to all other XFramesSupplier which are available from this node of frame tree
XFrame | getActiveFrame ()
| gets the current active frame of this container (not of any other available supplier)
void | setActiveFrame ([in] XFrame Frame)
| is called on activation of a direct sub-frame.
Public Member Functions inherited from XFrame
void | initialize ([in] com::sun::star::awt::XWindow xWindow)
| is called to initialize the frame within a window - the container window.
com::sun::star::awt::XWindow | getContainerWindow ()
| provides access to the container window of the frame.
void | setCreator ([in] XFramesSupplier Creator)
| sets the frame container that created this frame.
XFramesSupplier | getCreator ()
| provides access to the creator (parent) of this frame
string | getName ()
| access to the name property of this frame
void | setName ([in] string aName)
| sets the name of the frame.
XFrame | findFrame ([in] string aTargetFrameName, [in] long nSearchFlags)
| searches for a frame with the specified name.
boolean | isTop ()
| determines if the frame is a top frame.
void | activate ()
| activates this frame and thus the component within.
void | deactivate ()
| is called by the creator frame when another sub-frame gets activated.
boolean | isActive ()
| determines if the frame is active.
boolean | setComponent ([in] com::sun::star::awt::XWindow xComponentWindow, [in] XController xController)
| sets a new component into the frame or release an existing one from a frame.
com::sun::star::awt::XWindow | getComponentWindow ()
| provides access to the component window
XController | getController ()
| provides access to the controller
void | contextChanged ()
| notifies the frame that the context of the controller within this frame changed (i.e.
void | addFrameActionListener ([in]XFrameActionListener xListener)
| registers an event listener, which will be called when certain things happen to the components within this frame or within sub-frames of this frame.
void | removeFrameActionListener ([in] XFrameActionListener xListener)
| unregisters an event listener
Public Member Functions inherited from XComponent
void | dispose ()
| The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references.
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object.
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list.
Public Member Functions inherited from XDesktop
boolean | terminate ()
| tries to terminate the desktop.
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.
void | removeTerminateListener ([in] XTerminateListener Listener)
| unregisters an event listener for termination events.
com::sun::star::container::XEnumerationAccess | getComponents ()
| provides read access to collection of all currently loaded components inside the frame tree
com::sun::star::lang::XComponent | getCurrentComponent ()
| provides read access to the component inside the tree which has the UI focus
XFrame | getCurrentFrame ()
| provides read access to the frame which contains the current component
Public Member Functions inherited from XComponentLoader
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 a URL into the specified new or existing frame.

## Detailed Description

Since
  LibreOffice 4.1

## Exported Interfaces

## ◆ XComponentLoader

interface XComponentLoader

supports simple API for loading components into the frame environment

## ◆ XDesktop

interface XDesktop

regulate life time of desktop environment and support high level access to components of sub frame tree

## ◆ XDispatchProvider

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:

- _blank
  is used to create a new frame when dispatching the URL.
- _default
  is used to recycle empty or create a new frame when dispatching the URL.
- _self
  forces the frame to dispatch the URL into itself. ("" means the same)
- _parent
  dispatches the URL into the parent frame.
- _top
  dispatches the URL into the top level frame, the frame where this is invoked belongs to.

See also
  XDispatch
  XFrame::findFrame()

## ◆ XDispatchProviderInterception

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.

## ◆ XFramesSupplier

interface XFramesSupplier

provides access to sub frames within this frame

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

- com/sun/star/frame/XDesktop2.idl