Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface 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  xPlugin,
[in] PluginVariable  aVariable )
raises( 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  plugin,
[in] string  url,
[in] string  target,
[in] ::com::sun::star::lang::XEventListener  listener )
raises( 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  plugin,
[in] string  url,
[in] string  target )
raises( 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  plugin,
[in] string  url,
[in] string  target,
[in] sequence< byte >  buf,
[in] boolean  file,
[in] ::com::sun::star::lang::XEventListener  listener )
raises( 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  plugin,
[in] string  url,
[in] string  target,
[in] sequence< byte >  buf,
[in] boolean  file )
raises( 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  plugin,
[in] string  mimetype,
[in] string  target,
[in] ::com::sun::star::io::XActiveDataSource  aSource )
raises( 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  plugin,
[in] string  message )
raises( PluginException );

Description
Displays a message in the browser status line.
Parameter plugin
plugin
Parameter message
message
getUserAgent
string
getUserAgent( [in] XPlugin  plugin )
raises( 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

Apache Software Foundation

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

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