LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XFrameLoader Interface Referencepublished

load components into a frame More...

import"XFrameLoader.idl";

Inheritance diagram for XFrameLoader:
XInterface FrameLoader ContentLoader

Public Member Functions

void load ([in] XFrame Frame, [in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments, [in] XLoadEventListener Listener)
 starts the loading of the specified resource into the specified Frame. More...
 
void cancel ()
 cancels the loading process. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

load components into a frame

It's an asynchronous loading. For synchronous processes use XSynchronousFrameLoader instead of this one. The generic load algorithm of the office supports both ones - but preferred the synchronous interface.

See also
XFrame

Member Function Documentation

void cancel ( )

cancels the loading process.

After returning from this call, neither the frame nor the load-event-listener specified in XFrameLoader::load() may be called back. Because only the owner of this process who called load method before can cancel this process. And he doesn't need any notification about that. On the other hand - nobody then this owner himself can be registered as an XLoadEventListener here.

void load ( [in] XFrame  Frame,
[in] string  URL,
[in] sequence< com::sun::star::beans::PropertyValue Arguments,
[in] XLoadEventListener  Listener 
)

starts the loading of the specified resource into the specified Frame.

Parameters
Framespecifies the loading target
URLdescribes the resource of loading component Support of special protocols are implementation details and depends from the environment.
Argumentsoptional arguments for loading (see com::sun::star::document::MediaDescriptor for further information)
Listenerthis listener will be informed about success
See also
XLoadEventListener

The documentation for this interface was generated from the following file: