LibreOffice
LibreOffice 4.2 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
XPluginInstance Interface Referencepublished

Allows to control an office side plugin instance and to communicate with it. More...

import"XPluginInstance.idl";

Inheritance diagram for XPluginInstance:
XInterface

Public Member Functions

void start ()
 Starts plugin operation. More...
 
void stop ()
 Stops plugin operation. More...
 
void destroy ()
 Destroy the plugin instance. More...
 
void createWindow ([in] any PlatformParentData, [in] boolean embedded)
 Creates a new window for plugin operation. More...
 
void newStream ([in] string MIMEDesc, [in] string theURL, [in] string filter, [in]::com::sun::star::io::XInputStream stream, [in] any sessionData)
 Notifies the plugin of a new stream to display. More...
 
void newURL ([in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData)
 Notifies the plugin of a new url to open as document. More...
 
void getHttpServerURL ([out] string aHost, [out] unsigned short aPort, [out] string aPrefix)
 Retrieves the URL of the HTTP Load balancing Slave. 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

Allows to control an office side plugin instance and to communicate with it.

This interface is oriented for communication with browsers plugins.

Member Function Documentation

void createWindow ( [in] any  PlatformParentData,
[in] boolean  embedded 
)

Creates a new window for plugin operation.

Parameters
PlatformParentData[in]: platform dependent window data
embedded[in]: selects embedded or full page plugin mode
void 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).

void getHttpServerURL ( [out] string  aHost,
[out] unsigned short  aPort,
[out] string  aPrefix 
)

Retrieves the URL of the HTTP Load balancing Slave.

Parameters
aHost[out]: the full qualified host name of the LBS
aPort[out]: the port number
aPrefix[out]: the url prefix to the portal
void newStream ( [in] string  MIMEDesc,
[in] string  theURL,
[in] string  filter,
[in] ::com::sun::star::io::XInputStream  stream,
[in] any  sessionData 
)

Notifies the plugin of a new stream to display.

Parameters
MIMEDesc[in]: the MIMEtype of the data stream
theURL[in]: the URL that denotes the stream
filter[in]: a filter string to suggest a component that should handle the document
stream[in]: the data stream
sessionData[in]: the data specifying the current session
void newURL ( [in] string  MIMEDesc,
[in] string  theURL,
[in] string  filter,
[in] any  sessionData 
)

Notifies the plugin of a new url to open as document.

Parameters
MIMEDesc[in]: the MIMEtype of the data stream
theURL[in]: the URL to be opened
filter[in]: a filter string to suggest a component that should handle the document
sessionData[in]: the data specifying the current session
void start ( )

Starts plugin operation.

This is called after a plugin instance is created.

void stop ( )

Stops plugin operation.

This is called when the user goes to another web page. The XPluginInstance::destroy() method is directly called afterwards.


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