represents the environment for a desktop component
Frames are the anchors for the office components and they are the components' link
to the outside world. They create a skeleton for the whole office api infrastructure
by building frame hierarchys. These hierarchies contains all currently loaded
documents and make it possible to walk during these trees.
A special service Desktop can(!) combine different of such trees
to a global one which life time will be controlled by it.
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.
supports interception mechanism for dispatched URLs
Registered objects can intercept, supress or deroute 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.
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.
provides access to the dispatch recorder of the frame
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 somewhere whish 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.
Note:
It's not recommended to cache an already getted supplier. Because there exist
no possibility to check for enabled/disabled recording then.
