Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XSynchronousFrameLoader
Description
loads a resource into a Frame.

Unlike the XFrameLoader interface, this loading will be synchronous.

See also
XFrameLoader

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

Description
starts the loading of the specified resource into the specified 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 loader thread only. Method XSynchronousFrameLoader::load() must return false then and caller of this method XSynchronousFrameLoader::cancel() already knows the state ...

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.