:: com :: sun :: star :: plugin ::

interface XPluginContext
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XPluginContext
Description
Interface receiving calls from a plugin library. A default context can be created using the PluginManager .

Methods' Summary
getValue Requests global application parameters like display connection on UNIX systems.
getURLNotify Requests a notification of completion of the operation on an URL.
getURL Requests an URL to be loaded into the frame target.
postURLNotify Posts data from a buffer or file to an URL and receives a notification upon completion.
postURL Posts data from a buffer or file to an URL.
newStream Requests a new stream that is created by the plugin and consumed by the browser.
displayStatusText Displays a message in the browser status line.
getUserAgent Returns an application dependent identification string. This is the same string that is transmitted by a browser to an http server.
Methods' Details
getValue
string
getValue(
 
[in] XPlugin
[in] PluginVariable 

raises(

 
xPlugin,
aVariable ) 
PluginException );

Description
Requests global application parameters like display connection on UNIX systems.
Parameter xPlugin
plugin
Parameter aVariable
variable
Returns
value
getURLNotify
void
getURLNotify(
 
[in] XPlugin
[in] string
[in] string
[in] ::com::sun::star::lang::XEventListener 

raises(

 
plugin,
url,
target,
listener ) 
PluginException );

Description
Requests a notification of completion of the operation on an URL.
Parameter plugin
plugin
Parameter url
url
Parameter target
target frame
Parameter listener
event listener
getURL
void
getURL(
 
[in] XPlugin
[in] string
[in] string 

raises(

 
plugin,
url,
target ) 
PluginException );

Description
Requests an URL to be loaded into the frame target.
Parameter plugin
plugin
Parameter url
url
Parameter target
target frame
postURLNotify
void
postURLNotify(
 
[in] XPlugin
[in] string
[in] string
[in] sequence< byte >
[in] boolean
[in] ::com::sun::star::lang::XEventListener 

raises(

 
plugin,
url,
target,
buf,
file,
listener ) 
PluginException );

Description
Posts data from a buffer or file to an URL and receives a notification upon completion.
Parameter plugin
plugin
Parameter url
url
Parameter target
target frame
Parameter buf
data
Parameter file
whether data is from file
Parameter listener
event listener
postURL
void
postURL(
 
[in] XPlugin
[in] string
[in] string
[in] sequence< byte >
[in] boolean 

raises(

 
plugin,
url,
target,
buf,
file ) 
PluginException );

Description
Posts data from a buffer or file to an URL.
Parameter plugin
plugin
Parameter url
url
Parameter target
target frame
Parameter buf
data
Parameter file
whether data is from file
newStream
void
newStream(
 
[in] XPlugin
[in] string
[in] string
[in] ::com::sun::star::io::XActiveDataSource 

raises(

 
plugin,
mimetype,
target,
aSource ) 
PluginException );

Description
Requests a new stream that is created by the plugin and consumed by the browser.
Parameter plugin
plugin
Parameter mimetype
mime type
Parameter target
target frame
Parameter aSource
data source
displayStatusText
void
displayStatusText(
 
[in] XPlugin
[in] string 

raises(

 
plugin,
message ) 
PluginException );

Description
Displays a message in the browser status line.
Parameter plugin
plugin
Parameter message
message
getUserAgent
string
getUserAgent(
 
[in] XPlugin 

raises(

 
plugin ) 
PluginException );

Description
Returns an application dependent identification string. This is the same string that is transmitted by a browser to an http server.
Parameter plugin
plugin
Returns
id
Top of Page