<html> <head> <title>Interface XPluginContext</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="XPluginContext-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">plugin</a> :: </p> </td> </tr> <tr> <td class="title">interface XPluginContext</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Interface receiving calls from a plugin library. A default context can be created using the <a href="PluginManager.html">PluginManager</a>. </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="#getValue">getValue</a></td> <td class="imsum_right">Requests global application parameters like display connection on UNIX systems. </td> </tr> <tr> <td class="imsum_left"><a href="#getURLNotify">getURLNotify</a></td> <td class="imsum_right">Requests a notification of completion of the operation on an URL. </td> </tr> <tr> <td class="imsum_left"><a href="#getURL">getURL</a></td> <td class="imsum_right">Requests an URL to be loaded into the frame target. </td> </tr> <tr> <td class="imsum_left"><a href="#postURLNotify">postURLNotify</a></td> <td class="imsum_right">Posts data from a buffer or file to an URL and receives a notification upon completion. </td> </tr> <tr> <td class="imsum_left"><a href="#postURL">postURL</a></td> <td class="imsum_right">Posts data from a buffer or file to an URL. </td> </tr> <tr> <td class="imsum_left"><a href="#newStream">newStream</a></td> <td class="imsum_right">Requests a new stream that is created by the plugin and consumed by the browser. </td> </tr> <tr> <td class="imsum_left"><a href="#displayStatusText">displayStatusText</a></td> <td class="imsum_right">Displays a message in the browser status line. </td> </tr> <tr> <td class="imsum_left"><a href="#getUserAgent">getUserAgent</a></td> <td class="imsum_right">Returns an application dependent identification string. This is the same string that is transmitted by a browser to an http server. </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="getValue" class="membertitle">getValue</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">string</td> </tr> <tr> <td valign="top"><b>getValue</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> xPlugin,</td> </tr> <tr> <td/><td valign="top">[in] <a href="PluginVariable.html">PluginVariable</a></td> <td valign="bottom"> aVariable )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Requests global application parameters like display connection on UNIX systems. </dd> <dt><b>Parameter xPlugin</b></dt> <dd>plugin </dd> <dt><b>Parameter aVariable</b></dt> <dd>variable </dd> <dt><b>Returns</b></dt> <dd>value </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getURLNotify" class="membertitle">getURLNotify</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>getURLNotify</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> target,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td> <td valign="bottom"> listener )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Requests a notification of completion of the operation on an URL. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter url</b></dt> <dd>url </dd> <dt><b>Parameter target</b></dt> <dd>target frame </dd> <dt><b>Parameter listener</b></dt> <dd>event listener </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">void</td> </tr> <tr> <td valign="top"><b>getURL</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> target )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Requests an URL to be loaded into the frame target. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter url</b></dt> <dd>url </dd> <dt><b>Parameter target</b></dt> <dd>target frame </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="postURLNotify" class="membertitle">postURLNotify</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>postURLNotify</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> target,</td> </tr> <tr> <td/><td valign="top">[in] sequence< byte ></td> <td valign="bottom"> buf,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> file,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td> <td valign="bottom"> listener )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Posts data from a buffer or file to an URL and receives a notification upon completion. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter url</b></dt> <dd>url </dd> <dt><b>Parameter target</b></dt> <dd>target frame </dd> <dt><b>Parameter buf</b></dt> <dd>data </dd> <dt><b>Parameter file</b></dt> <dd>whether data is from file </dd> <dt><b>Parameter listener</b></dt> <dd>event listener </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">void</td> </tr> <tr> <td valign="top"><b>postURL</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> target,</td> </tr> <tr> <td/><td valign="top">[in] sequence< byte ></td> <td valign="bottom"> buf,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> file )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Posts data from a buffer or file to an URL. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter url</b></dt> <dd>url </dd> <dt><b>Parameter target</b></dt> <dd>target frame </dd> <dt><b>Parameter buf</b></dt> <dd>data </dd> <dt><b>Parameter file</b></dt> <dd>whether data is from file </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">void</td> </tr> <tr> <td valign="top"><b>newStream</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> mimetype,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> 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"> aSource )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Requests a new stream that is created by the plugin and consumed by the browser. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter mimetype</b></dt> <dd>mime type </dd> <dt><b>Parameter target</b></dt> <dd>target frame </dd> <dt><b>Parameter aSource</b></dt> <dd>data source </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="displayStatusText" class="membertitle">displayStatusText</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>displayStatusText</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> message )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Displays a message in the browser status line. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Parameter message</b></dt> <dd>message </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUserAgent" class="membertitle">getUserAgent</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">string</td> </tr> <tr> <td valign="top"><b>getUserAgent</b>(</td> <td valign="top">[in] <a href="XPlugin.html">XPlugin</a></td> <td valign="bottom"> plugin )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="PluginException.html">PluginException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns an application dependent identification string. This is the same string that is transmitted by a browser to an http server. </dd> <dt><b>Parameter plugin</b></dt> <dd>plugin </dd> <dt><b>Returns</b></dt> <dd>id </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>