Sophie

Sophie

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

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

<html>
<head>
<title>Interface XLibraryAccess</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="XLibraryAccess-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> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">deprecated </td>
<td width="50%" class="title">interface XLibraryAccess</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dt><b>Description</b></dt>
<dd>provides access to additional scripting code.
 
 </dd>
<dd><p>This code is organized in modules and these modules contain 
 the functions. It is possible to get just the code from a function, 
 but you can also get the whole code of a module with all functions in it.</p>
 </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="#isFunction">isFunction</a></td>
<td class="imsum_right">returns <b>true</b>, if the function is accessible through this library; 
 otherwise it returns <b>false</b>. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isValidPath">isValidPath</a></td>
<td class="imsum_right">returns <b>true</b> if a fully qualified function name begins with this name. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getModuleNames">getModuleNames</a></td>
<td class="imsum_right">Return all module names which contain code. 
 e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getModuleSource">getModuleSource</a></td>
<td class="imsum_right">get the source code of a module.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getModuleCode">getModuleCode</a></td>
<td class="imsum_right">Get the hole compiled code of a module. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFunctionSource">getFunctionSource</a></td>
<td class="imsum_right">get the source code of a function.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFunctionCode">getFunctionCode</a></td>
<td class="imsum_right">Get the compiled code of a function. 
 
 &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="isFunction" class="membertitle">isFunction</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>isFunction</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aFunctionName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b>, if the function is accessible through this library; 
 otherwise it returns <b>false</b>. 
 
 </dd>
<dt><b>Parameter aFunctionName</b></dt>
<dd>the fully qualified name of a funtion. 
 (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isValidPath" class="membertitle">isValidPath</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>isValidPath</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aPathName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns <b>true</b> if a fully qualified function name begins with this name. 
 
 </dd>
<dt><b>Parameter aPathName</b></dt>
<dd>a part of a function name (e.g., "UtilLibrary").
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getModuleNames" class="membertitle">getModuleNames</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">sequence&lt; string &gt;</td>
</tr>
<tr>
<td valign="top"><b>getModuleNames</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Return all module names which contain code. 
 e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getModuleSource" class="membertitle">getModuleSource</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>getModuleSource</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aModulName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the source code of a module.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getModuleCode" class="membertitle">getModuleCode</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">sequence&lt; byte &gt;</td>
</tr>
<tr>
<td valign="top"><b>getModuleCode</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aModuleName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the hole compiled code of a module. 
 
 </dd>
<dt><b>Parameter ModuleName</b></dt>
<dd>the full qualified name of a module. 
 (e.g., "UtilLibrary.ModuleDate") 
 </dd>
<dt><b>Returns</b></dt>
<dd>an empty sequence, if this module is not found or the 
 code is not compiled.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFunctionSource" class="membertitle">getFunctionSource</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>getFunctionSource</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aFunctionName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>get the source code of a function.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFunctionCode" class="membertitle">getFunctionCode</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">sequence&lt; byte &gt;</td>
</tr>
<tr>
<td valign="top"><b>getFunctionCode</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;FunctionName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get the compiled code of a function. 
 
 </dd>
<dt><b>Parameter FunctionName</b></dt>
<dd>the full qualified name of a function. 
 (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate") 
 </dd>
<dt><b>Returns</b></dt>
<dd>an empty sequence, if this function is not found.
 </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>