Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: frame ::

service Frame

Description
represents the environment for a desktop component.


Exported Interfaces

com::sun::star::frame::XFrame
Description
allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component.
com::sun::star::frame::XDispatchProvider
Description
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.
  • _self forces the frame to dispatch the URL into itself.
  • _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.
  • _helpagent dispatches the URL into the help agent window belonging to the frame.

See also
XDispatch
com::sun::star::frame::XFramesSupplier
[ OPTIONAL ]
Description
This optional interface is used to access sub-frames within this Frame.
com::sun::star::task::XStatusIndicatorFactory
[ OPTIONAL ]
Description
This optional interface supplies access to XStatusIndicator s for the component within the frame.

Top of Page