Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 4273

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XPluginInstance</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XPluginInstance-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">mozilla</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XPluginInstance</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Allows to controll an office side plugin instance and to communicate with it.
 This interface is oriented for communication with browsers plugins.
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#start">start</a></td>
<td class="imsum_right">Starts plugin operation. This is called after a plugin instance is
 created.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#stop">stop</a></td>
<td class="imsum_right">Stops plugin operation. This is called when the user goes to another web
 page. The <a href="XPluginInstance.html">XPluginInstance</a>::<a href="XPluginInstance.html#destroy">destroy</a> method is directly called
 afterwards.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#destroy">destroy</a></td>
<td class="imsum_right">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).
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createWindow">createWindow</a></td>
<td class="imsum_right">Creates a new window for plugin operation.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#newStream">newStream</a></td>
<td class="imsum_right">Notifies the plugin of a new stream to display.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#newURL">newURL</a></td>
<td class="imsum_right">Notifies the plugin of a new url to open as document.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getHttpServerURL">getHttpServerURL</a></td>
<td class="imsum_right">Retrieves the URL of the HTTP Loadbalancing Slave.

 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="start" class="membertitle">start</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>start</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Starts plugin operation. This is called after a plugin instance is
 created.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="stop" class="membertitle">stop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>stop</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Stops plugin operation. This is called when the user goes to another web
 page. The <a href="XPluginInstance.html">XPluginInstance</a>::<a href="XPluginInstance.html#destroy">destroy</a> method is directly called
 afterwards.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="destroy" class="membertitle">destroy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>destroy</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>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).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createWindow" class="membertitle">createWindow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>createWindow</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;PlatformParentData,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;embedded );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Creates a new window for plugin operation.

 </dd>
<dt><b>Parameter PlatformParentData</b></dt>
<dd>[in]: platform dependent window data
 </dd>
<dt><b>Parameter embedded</b></dt>
<dd>[in]: selects embedded or full page plugin mode

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="newStream" class="membertitle">newStream</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>newStream</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;MIMEDesc,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;theURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;filter,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td>
<td valign="bottom">&nbsp;stream,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;sessionData );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Notifies the plugin of a new stream to display.

 </dd>
<dt><b>Parameter MIMEDesc</b></dt>
<dd>[in]: the MIMEtype of the data stream
 </dd>
<dt><b>Parameter theURL</b></dt>
<dd>[in]: the URL that denotes the stream
 </dd>
<dt><b>Parameter filter</b></dt>
<dd>[in]: a filter string to suggest a component that should handle the document
 </dd>
<dt><b>Parameter stream</b></dt>
<dd>[in]: the data stream
 </dd>
<dt><b>Parameter sessiondata</b></dt>
<dd>[in]: the data specifying the current session

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="newURL" class="membertitle">newURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>newURL</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;MIMEDesc,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;theURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;filter,</td>
</tr>
<tr>
<td/><td valign="top">[in] any</td>
<td valign="bottom">&nbsp;sessionData );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Notifies the plugin of a new url to open as document.

 </dd>
<dt><b>Parameter MIMEDesc</b></dt>
<dd>[in]: the MIMEtype of the data stream
 </dd>
<dt><b>Parameter theURL</b></dt>
<dd>[in]: the URL to be openend
 </dd>
<dt><b>Parameter filter</b></dt>
<dd>[in]: a filter string to suggest a component that should handle the document
 </dd>
<dt><b>Parameter sessiondata</b></dt>
<dd>[in]: the data specifying the current session

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getHttpServerURL" class="membertitle">getHttpServerURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>getHttpServerURL</b>(</td>
<td valign="top">[out] string</td>
<td valign="bottom">&nbsp;aHost,</td>
</tr>
<tr>
<td/><td valign="top">[out] unsigned short</td>
<td valign="bottom">&nbsp;aPort,</td>
</tr>
<tr>
<td/><td valign="top">[out] string</td>
<td valign="bottom">&nbsp;aPrefix );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Retrieves the URL of the HTTP Loadbalancing Slave.

 </dd>
<dt><b>Parameter aURL</b></dt>
<dd>[out]: the full qualified host name of the LBS
 </dd>
<dt><b>Parameter aPort</b></dt>
<dd>[out]: the port number
 </dd>
<dt><b>Parameter aPrefix</b></dt>
<dd>[out]: the url prefix to the portal

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>