Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: mozilla ::

interface XPluginInstancePeer

Base Interface
com::sun::star::uno::XInterface



Methods' Summary

setWindowSize Alters the plugin's window size in the browser window.
showStatusMessage Show status / hint message in browser's message area.
enableScripting Indicates to the plugin that the document was loaded successfully and scripting interfaces are now available.
newStream Creates a new stream of data produced by the plug-in and consumed by the browser.
getURL Fetches an URL into the target window. The parameters and their meaning map to the corresponding Netscape-API call.
postURL Posts to a URL with post data and/or post headers. The parameters and their meaning map to the corresponding Netscape-API call.

Methods' Details

setWindowSize
 
boolean
setWindowSize(
[ in ] long width,
[ in ] long heigth );

Description
Alters the plugin's window size in the browser window.
Parameter width
[in]: the new window width
Parameter height
[in]: the new window height
Returns
TRUE on success
showStatusMessage
 
[ oneway ] void
showStatusMessage(
[ in ] string message );

Description
Show status / hint message in browser's message area.
Parameter message
[in]: the string to be displayed
enableScripting
 
[ oneway ] void
enableScripting(
[ in ] com::sun::star::uno::XInterface document,
[ in ] com::sun::star::lang::XMultiServiceFactory servicemanager );

Description
Indicates to the plugin that the document was loaded successfully and scripting interfaces are now available.
Parameter document
[in]: the active document
Parameter servicemanager
[in]: the office servicemanager
newStream
 
[ oneway ] void
newStream(
[ in ] string MIMEDesc,
[ in ] string target,
[ in ] com::sun::star::io::XActiveDataSource data );

Description
Creates a new stream of data produced by the plug-in and consumed by the browser.
Parameter MIMEDesc
[in]: the MIME type of the plug-in to create
Parameter target
[in]: the name of the target window or frame (supports _blank, _self)
Parameter data
[in]: on success the outputstream will be associated with this instance
getURL
 
[ oneway ] void
getURL(
[ in ] string aURL,
[ in ] string target,
[ in ] string alternativeHost,
[ in ] string referrer,
[ in ] com::sun::star::mozilla::XPluginInstanceNotifySink sink );

Description
Fetches an URL into the target window. The parameters and their meaning map to the corresponding Netscape-API call.
Parameter aURL
[in]: the URL to be fetched
Parameter target
[in]: the name of the target window or frame (supports _blank, _self)
Parameter alternativeHost
[in]: alternativeHost
Parameter referrer
[in]: referrer
Parameter sink
[in]: the sink is notified on success
postURL
 
[ oneway ] void
postURL(
[ in ] string aURL,
[ in ] com::sun::star::io::XInputStream postData,
[ in ] string target,
[ in ] string alternativeHost,
[ in ] string referrer,
[ in ] com::sun::star::io::XInputStream postHeaders,
[ in ] com::sun::star::mozilla::XPluginInstanceNotifySink sink );

Description
Posts to a URL with post data and/or post headers. The parameters and their meaning map to the corresponding Netscape-API call.
Parameter aURL
[in]: the URL to be posted to
Parameter postData
[in]: the data to be posted
Parameter target
[in]: the name of the target window or frame (supports _blank, _self)
Parameter alternativeHost
[in]: alternativeHost
Parameter referrer
[in]: referrer
Parameter postHeaders
[in]: the header to be posted
Parameter sink
[in]: the sink is notified on success

Top of Page