LibreOffice
LibreOffice 5.0 SDK API Reference
|
import "XFrame2.idl";
Exported Interfaces | |
interface | XDispatchProvider |
provides access to dispatchers for the frame. More... | |
interface | XDispatchInformationProvider |
provides information about supported commands More... | |
interface | XDispatchProviderInterception |
supports interception mechanism for dispatched URLs More... | |
interface | XFramesSupplier |
Provides access to sub frames within this frame, and via its XFrame sub-interface: Allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component. More... | |
interface | com::sun::star::task::XStatusIndicatorFactory |
supplies access to com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses More... | |
Public Attributes | |
com::sun::star::container::XNameContainer | UserDefinedAttributes |
contains user defined attributes. More... | |
string | Title |
if possible it sets/gets the UI title on/from the frame container window More... | |
XDispatchRecorderSupplier | DispatchRecorderSupplier |
provides access to the dispatch recorder of the frame More... | |
com::sun::star::uno::XInterface | LayoutManager |
Provides access to the LayoutManager of the frame. 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... | |
![]() | |
sequence< short > | getSupportedCommandGroups () |
returns all supported command groups. More... | |
sequence< DispatchInformation > | getConfigurableDispatchInformation ([in] short CommandGroup) |
returns additional information about supported commands of a given command group. 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... | |
![]() | |
com::sun::star::task::XStatusIndicator | createStatusIndicator () |
create a new status indicator instance More... | |
supplies access to com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses
interface XDispatchInformationProvider |
provides information about supported commands
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, and via its XFrame sub-interface: Allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component.
provides access to the dispatch recorder of the frame
<p> Such recorder can be used to record dispatch requests. The supplier contains a dispatch recorder and provide the functionality to use it for any dispatch object from outside which supports the interface XDispatch. A supplier is available only, if recording was enabled. That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. If value of this property is `NULL` he must call XDispatch::dispatch() on the original dispatch object. If it's a valid value he must use the supplier by calling his method XDispatchRecorderSupplier::dispatchAndRecord() with the original dispatch object as argument. </p> <p> Note:<br> It's not recommended to cache an already gotten supplier. Because there exist no possibility to check for enabled/disabled recording then. </p>
|
attribute |
Provides access to the LayoutManager of the frame.
This is actually of type XLayoutManager, but this API is still experimental (unpublished).
|
attribute |
if possible it sets/gets the UI title on/from the frame container window
It depends from the type of the frame container window. If it is a system task window all will be OK. Otherwise the title can't be set. Setting/getting of the pure value of this property must be possible in every case. Only showing on the UI can be fail.
|
attributereadonly |
contains user defined attributes.