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 :: mozilla ::

interface XPluginInstance
Description
Allows to controll an office side plugin instance and to communicate with it. This interface is oriented for communication with browsers plugins.

Methods' Summary
start Starts plugin operation. This is called after a plugin instance is created.  
stop Stops plugin operation. This is called when the user goes to another web page. The XPluginInstance::destroy method is directly called afterwards.  
destroy Destroy the plugin instance. This method is called when it is no longer possible to return to the plugin instance, because it was destroyed by the browser (e.g., window close).  
createWindow Creates a new window for plugin operation.  
newStream Notifies the plugin of a new stream to display.  
newURL Notifies the plugin of a new url to open as document.  
getHttpServerURL Retrieves the URL of the HTTP Loadbalancing Slave.  
Methods' Details
start
[oneway] void
start();

Description
Starts plugin operation. This is called after a plugin instance is created.
stop
[oneway] void
stop();

Description
Stops plugin operation. This is called when the user goes to another web page. The XPluginInstance::destroy method is directly called afterwards.
destroy
[oneway] void
destroy();

Description
Destroy the plugin instance. This method is called when it is no longer possible to return to the plugin instance, because it was destroyed by the browser (e.g., window close).
createWindow
[oneway] void
createWindow( [in] any  PlatformParentData,
[in] boolean  embedded );

Description
Creates a new window for plugin operation.
Parameter PlatformParentData
[in]: platform dependent window data
Parameter embedded
[in]: selects embedded or full page plugin mode
newStream
[oneway] void
newStream( [in] string  MIMEDesc,
[in] string  theURL,
[in] string  filter,
[in] ::com::sun::star::io::XInputStream  stream,
[in] any  sessionData );

Description
Notifies the plugin of a new stream to display.
Parameter MIMEDesc
[in]: the MIMEtype of the data stream
Parameter theURL
[in]: the URL that denotes the stream
Parameter filter
[in]: a filter string to suggest a component that should handle the document
Parameter stream
[in]: the data stream
Parameter sessiondata
[in]: the data specifying the current session
newURL
[oneway] void
newURL( [in] string  MIMEDesc,
[in] string  theURL,
[in] string  filter,
[in] any  sessionData );

Description
Notifies the plugin of a new url to open as document.
Parameter MIMEDesc
[in]: the MIMEtype of the data stream
Parameter theURL
[in]: the URL to be openend
Parameter filter
[in]: a filter string to suggest a component that should handle the document
Parameter sessiondata
[in]: the data specifying the current session
getHttpServerURL
void
getHttpServerURL( [out] string  aHost,
[out] unsigned short  aPort,
[out] string  aPrefix );

Description
Retrieves the URL of the HTTP Loadbalancing Slave.
Parameter aURL
[out]: the full qualified host name of the LBS
Parameter aPort
[out]: the port number
Parameter aPrefix
[out]: the url prefix to the portal
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.