Google Git
Sign in
apache / xalan-site / fc63e1a05362d8a54765634eed15aec345e1ef1d / . / content / old / xalan-c / apiDocs / classTopLevelArg.html
blob: dfc4e3018d2e50f9300d58923c6ff2de90452dc1 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>TopLevelArg Class Reference</h1>This class holds an instance of an argument on the stack.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="TopLevelArg_8hpp-source.html">TopLevelArg.hpp</a>&gt;</code>
<p>
Collaboration diagram for TopLevelArg:<p><center><img src="classTopLevelArg__coll__graph.gif" border="0" usemap="#TopLevelArg_coll_map" alt="Collaboration graph"></center>
<map name="TopLevelArg_coll_map">
<area href="classXalanQNameByValue.html" shape="rect" coords="82,328,226,304">
<area href="classXalanQName.html" shape="rect" coords="250,236,346,212">
<area href="classXalanDOMString.html" shape="rect" coords="116,43,233,19">
<area href="classXObject.html" shape="rect" coords="434,236,501,212">
<area href="classXObjectPtr.html" shape="rect" coords="273,328,358,304">
<area href="classXalanReferenceCountedObject.html" shape="rect" coords="433,43,630,19">
<area href="classXObjectFactory.html" shape="rect" coords="654,43,764,19">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classTopLevelArg-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classTopLevelArg.html#a0">TopLevelArg</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expr)
<dl class="el"><dd><font size=-1><em>Construct an argument object from a string expression.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classTopLevelArg.html#a1">TopLevelArg</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> variable=<a class="el" href="classXObjectPtr.html">XObjectPtr</a>())
<dl class="el"><dd><font size=-1><em>Construct an argument object from an <a class="el" href="classXObject.html">XObject</a> instance.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li><a class="el" href="classTopLevelArg.html#a2">TopLevelArg</a> (const TopLevelArg &amp;theSource, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<dl class="el"><dd><font size=-1><em>Copy constructor.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li><a class="el" href="classTopLevelArg.html#a3">~TopLevelArg</a> ()
<dl class="el"><dd><font size=-1><em>Destructor.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanQName.html">XalanQName</a>&amp; <a class="el" href="classTopLevelArg.html#a4">getName</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object name.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classTopLevelArg.html#a5">getExpression</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object's expression.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <a class="el" href="classTopLevelArg.html#a6">getXObject</a> () const
<dl class="el"><dd><font size=-1><em>Retrieve object's <a class="el" href="classXObject.html">XObject</a> variable.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>TopLevelArg&amp; <a class="el" href="classTopLevelArg.html#a7">operator=</a> (const TopLevelArg &amp;theRHS)
<dl class="el"><dd><font size=-1><em>Assignment operator.</em> <a href="#a7">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Methods</h2>
<ul>
<li>TopLevelArg* <a class="el" href="classTopLevelArg.html#d0">create</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expr)
<li>TopLevelArg* <a class="el" href="classTopLevelArg.html#d1">create</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> variable=<a class="el" href="classXObjectPtr.html">XObjectPtr</a>())
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class holds an instance of an argument on the stack.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="TopLevelArg::TopLevelArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg::TopLevelArg (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>expr</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct an argument object from a string expression.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
&nbsp;</td><td>
name of argument </td></tr>
<tr><td valign=top><em>expr</em>
&nbsp;</td><td>
expression argument represents </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="TopLevelArg::TopLevelArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg::TopLevelArg (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <em>variable</em> = <a class="el" href="classXObjectPtr.html">XObjectPtr</a>()&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct an argument object from an <a class="el" href="classXObject.html">XObject</a> instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>
&nbsp;</td><td>
name of argument </td></tr>
<tr><td valign=top><em>variable</em>
&nbsp;</td><td>
the <a class="el" href="classXObject.html">XObject</a> instance. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="TopLevelArg::TopLevelArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg::TopLevelArg (
</b></td>
<td valign="bottom"><b>
const TopLevelArg &amp; <em>theSource</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Copy constructor.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSource</em>
&nbsp;</td><td>
the TopLevelArg to copy. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="TopLevelArg::~TopLevelArg"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg::~TopLevelArg (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d1" doxytag="TopLevelArg::create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg * TopLevelArg::create (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <em>variable</em> = <a class="el" href="classXObjectPtr.html">XObjectPtr</a>()&nbsp;)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="d0" doxytag="TopLevelArg::create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg * TopLevelArg::create (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>name</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>expr</em>&nbsp;)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="TopLevelArg::getExpression"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; TopLevelArg::getExpression (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object's expression.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
string representation of expression </dl> </td>
</tr>
</table>
<a name="a4" doxytag="TopLevelArg::getName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; TopLevelArg::getName (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object name.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
qualified name of object </dl> </td>
</tr>
</table>
<a name="a6" doxytag="TopLevelArg::getXObject"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> TopLevelArg::getXObject (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve object's <a class="el" href="classXObject.html">XObject</a> variable.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
pointer to the <a class="el" href="classXObject.html">XObject</a> instance </dl> </td>
</tr>
</table>
<a name="a7" doxytag="TopLevelArg::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
TopLevelArg &amp; TopLevelArg::operator= (
</b></td>
<td valign="bottom"><b>
const TopLevelArg &amp; <em>theRHS</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Assignment operator.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TopLevelArg_8hpp-source.html">TopLevelArg.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>