Sophie

Sophie

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

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

<html>
<head>
<title>Interface XPluginInstancePeer</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="XPluginInstancePeer-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 XPluginInstancePeer</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Allows to communicate with a plugin from the office side.
 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="#setWindowSize">setWindowSize</a></td>
<td class="imsum_right">Alters the plugin's window size in the browser window.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#showStatusMessage">showStatusMessage</a></td>
<td class="imsum_right">Show status / hint message in browser's message area.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#enableScripting">enableScripting</a></td>
<td class="imsum_right">Indicates to the plugin that the document was loaded successfully and scripting
 interfaces are now available.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#newStream">newStream</a></td>
<td class="imsum_right">Creates a new stream of data produced by the plug-in and consumed by
 the browser.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getURL">getURL</a></td>
<td class="imsum_right">Fetches an URL into the target window. The parameters and their meaning map to the 
 corresponding Netscape-API call.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#postURL">postURL</a></td>
<td class="imsum_right">Posts to a URL with post data and/or post headers. The parameters and their meaning 
 map to the corresponding Netscape-API call.

 &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="setWindowSize" class="membertitle">setWindowSize</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">boolean</td>
</tr>
<tr>
<td valign="top"><b>setWindowSize</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;width,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;heigth );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Alters the plugin's window size in the browser window.

 </dd>
<dt><b>Parameter width</b></dt>
<dd>[in]: the new window width
 </dd>
<dt><b>Parameter height</b></dt>
<dd>[in]: the new window height

 </dd>
<dt><b>Returns</b></dt>
<dd><CODE>TRUE</CODE> on success
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="showStatusMessage" class="membertitle">showStatusMessage</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>showStatusMessage</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;message );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Show status / hint message in browser's message area.

 </dd>
<dt><b>Parameter message</b></dt>
<dd>[in]: the string to be displayed
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="enableScripting" class="membertitle">enableScripting</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>enableScripting</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td>
<td valign="bottom">&nbsp;document,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a></td>
<td valign="bottom">&nbsp;servicemanager );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Indicates to the plugin that the document was loaded successfully and scripting
 interfaces are now available.

 </dd>
<dt><b>Parameter document</b></dt>
<dd>[in]: the active document
 </dd>
<dt><b>Parameter servicemanager</b></dt>
<dd>[in]: the office servicemanager

 </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;target,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XActiveDataSource.html">XActiveDataSource</a></td>
<td valign="bottom">&nbsp;data );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Creates a new stream of data produced by the plug-in and consumed by
 the browser.

 </dd>
<dt><b>Parameter MIMEDesc</b></dt>
<dd>[in]: the MIME type of the plug-in to create
 </dd>
<dt><b>Parameter target</b></dt>
<dd>[in]: the name of the target window or frame (supports _blank, _self)
 </dd>
<dt><b>Parameter data</b></dt>
<dd>[in]: on success the outputstream will be associated with this instance

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getURL" class="membertitle">getURL</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>getURL</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;target,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;alternativeHost,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;referrer,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPluginInstanceNotifySink.html">XPluginInstanceNotifySink</a></td>
<td valign="bottom">&nbsp;sink );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Fetches an URL into the target window. The parameters and their meaning map to the 
 corresponding Netscape-API call.
 
 </dd>
<dt><b>Parameter aURL</b></dt>
<dd>[in]: the URL to be fetched
 </dd>
<dt><b>Parameter target</b></dt>
<dd>[in]: the name of the target window or frame (supports _blank, _self)
 </dd>
<dt><b>Parameter alternativeHost</b></dt>
<dd>[in]: alternativeHost 
 </dd>
<dt><b>Parameter referrer</b></dt>
<dd>[in]: referrer
 </dd>
<dt><b>Parameter sink</b></dt>
<dd>[in]: the sink is notified on success

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="postURL" class="membertitle">postURL</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>postURL</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aURL,</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;postData,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;target,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;alternativeHost,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;referrer,</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;postHeaders,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XPluginInstanceNotifySink.html">XPluginInstanceNotifySink</a></td>
<td valign="bottom">&nbsp;sink );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Posts to a URL with post data and/or post headers. The parameters and their meaning 
 map to the corresponding Netscape-API call.

 </dd>
<dt><b>Parameter aURL</b></dt>
<dd>[in]: the URL to be posted to
 </dd>
<dt><b>Parameter postData</b></dt>
<dd>[in]: the data to be posted
 </dd>
<dt><b>Parameter target</b></dt>
<dd>[in]: the name of the target window or frame (supports _blank, _self)
 </dd>
<dt><b>Parameter alternativeHost</b></dt>
<dd>[in]: alternativeHost 
 </dd>
<dt><b>Parameter referrer</b></dt>
<dd>[in]: referrer
 </dd>
<dt><b>Parameter postHeaders</b></dt>
<dd>[in]: the header to be posted
 </dd>
<dt><b>Parameter sink</b></dt>
<dd>[in]: the sink is notified on success

 </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>