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

interface XSynchronousFrameLoader
Base Interfaces
::com::sun::star::uno::XInterface
  |  
  +--XSynchronousFrameLoader
::com::sun::star::uno::XInterface
(referenced interface's summary:)
base interface of all UNO interfaces
Description
loads a resource into a ::com::sun::star::frame::Frame .

Unlike the ::com::sun::star::frame::XFrameLoader interface, this loading will be synchronous.

See also
::com::sun::star::frame::XFrameLoader

Methods' Summary
load starts the loading of the specified resource into the specified ::com::sun::star::frame::Frame .  
cancel cancels the loading process.  
Methods' Details
load
boolean
load( [in] sequence< ::com::sun::star::beans::PropertyValue >  Descriptor,
[in] ::com::sun::star::frame::XFrame  Frame );

Description
starts the loading of the specified resource into the specified ::com::sun::star::frame::Frame .
Parameter Descriptor
describes the ressource which should be loaded It use a ::com::sun::star::document::MediaDescriptor for that.
Parameter Frame
the target frame which should contain the new loaded component
Returns
true if loading is successfully
false otherwise
cancel
void
cancel();

Description
cancels the loading process.

No notifications (neither to the frame or the caller) must be notified. Because it's a synchronous process this cancel call can be forced by another thread the the loader thread only. Method ::com::sun::star::frame::XSynchronousFrameLoader::load() must return false then and caller of this method ::com::sun::star::frame::XSynchronousFrameLoader::cancel() already knows the state ...

Top of Page