Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 5136

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XScriptContext</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="XScriptContext-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">script</a> :: <a href="module-ix.html" class="namechain">provider</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XScriptContext</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>This interface is provided to scripts, and provides a means of access to 
 the various interfaces which they might need to perform some action on 
 a document. It is required to be passed as the first argument for any 
 Java scripts.
</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="#getDocument">getDocument</a></td>
<td class="imsum_right">Obtain the document reference on which the script can operate

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getInvocationContext">getInvocationContext</a></td>
<td class="imsum_right">provides access to the context where the script was invoked

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDesktop">getDesktop</a></td>
<td class="imsum_right">Obtain the desktop reference on which the script can operate

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getComponentContext">getComponentContext</a></td>
<td class="imsum_right">Obtain the component context which the script can use to create 
 other uno components

 &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="getDocument" class="membertitle">getDocument</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">::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XModel.html">XModel</a></td>
</tr>
<tr>
<td valign="top"><b>getDocument</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Obtain the document reference on which the script can operate

 </dd>
<dt><b>Returns</b></dt>
<dd>::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XModel.html">XModel</a> interface
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getInvocationContext" class="membertitle">getInvocationContext</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">::com::sun::star::<a href="../../document/module-ix.html">document</a>::<a href="../../document/XScriptInvocationContext.html">XScriptInvocationContext</a></td>
</tr>
<tr>
<td valign="top"><b>getInvocationContext</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides access to the context where the script was invoked

 </dd>
<dd><p>In some cases, it is possible that scripts, embedded in a document,
 are executed from within a context which is <em>not</em> the document
 itself. In this case, the <code>getInvocationContext</code> member allows
 to access this context.</p>

 <p>Note that the returned context is allowed to be <b>NULL</b>, in this case,
 the document as returned by <code>getDocument</code> is the invocation context.</p>

 <p>If the returned context is not <b>NULL</b>, its <code>ScriptContainer</code> attribute
 equals the document as returned by <code>XScriptContext::getDocument</code>.</p>

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDesktop" class="membertitle">getDesktop</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">::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XDesktop.html">XDesktop</a></td>
</tr>
<tr>
<td valign="top"><b>getDesktop</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Obtain the desktop reference on which the script can operate

 </dd>
<dt><b>Returns</b></dt>
<dd>::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XDesktop.html">XDesktop</a> interface
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getComponentContext" class="membertitle">getComponentContext</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">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/XComponentContext.html">XComponentContext</a></td>
</tr>
<tr>
<td valign="top"><b>getComponentContext</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Obtain the component context which the script can use to create 
 other uno components

 </dd>
<dt><b>Returns</b></dt>
<dd>::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/XComponentContext.html">XComponentContext</a> interface
 </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; 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>