blob: 15a1083405bef2d0d7de1506150aa974336f7dde [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>XSpan Class Reference</h1><code>#include &lt;<a class="el" href="XSpan_8hpp-source.html">XSpan.hpp</a>&gt;</code>
<p>
Inheritance diagram for XSpan:<p><center><img src="classXSpan__inherit__graph.gif" border="0" usemap="#XSpan_inherit_map" alt="Inheritance graph"></center>
<map name="XSpan_inherit_map">
<area href="classXNodeSet.html" shape="rect" coords="66,266,144,242">
<area href="classXNodeSetBase.html" shape="rect" coords="53,191,157,168">
<area href="classXObject.html" shape="rect" coords="72,117,138,93">
<area href="classXalanReferenceCountedObject.html" shape="rect" coords="6,42,204,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XSpan:<p><center><img src="classXSpan__coll__graph.gif" border="0" usemap="#XSpan_coll_map" alt="Collaboration graph"></center>
<map name="XSpan_coll_map">
<area href="classXNodeSet.html" shape="rect" coords="338,415,416,391">
<area href="classXNodeSetBase.html" shape="rect" coords="130,325,234,301">
<area href="classXNodeSetResultTreeFragProxy.html" shape="rect" coords="93,415,293,391">
<area href="classXObject.html" shape="rect" coords="178,234,245,210">
<area href="classXalanDOMString.html" shape="rect" coords="32,42,149,18">
<area href="classXPathExecutionContext_1_1BorrowReturnMutableNodeRefList.html" shape="rect" coords="258,325,608,301">
<area href="classXPathExecutionContext.html" shape="rect" coords="298,234,450,210">
<area href="classMutableNodeRefList.html" shape="rect" coords="500,234,633,210">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSpan-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXSpan.html#a0">XSpan</a> (<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp;value, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<dl class="el"><dd><font size=-1><em>Construct an XSpan object from a node list.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classXSpan.html#a1">XSpan</a> (const XSpan &amp;source, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<li>virtual <a class="el" href="classXSpan.html#a2">~XSpan</a> ()
<li>virtual int <a class="el" href="classXSpan.html#a3">getStart</a> () const
<dl class="el"><dd><font size=-1><em>Get the start span offset from the first node, or -1 if offset isn't set.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXSpan.html#a4">setStart</a> (int start)
<dl class="el"><dd><font size=-1><em>Set the start span offset from the first node, or pass -1 if offset isn't set.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual int <a class="el" href="classXSpan.html#a5">getEnd</a> () const
<dl class="el"><dd><font size=-1><em>Get the end span offset from start of the last node, or -1 if offset isn't set.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXSpan.html#a6">setEnd</a> (int end)
<dl class="el"><dd><font size=-1><em>Set the end span offset from start of the last node, or -1 if offset isn't set.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXSpan.html#a7">setSpan</a> (int firstNodeOffset, int lastNodeOffset)
<dl class="el"><dd><font size=-1><em>Set the range of the span, based on offsets from the first node and offsets from the last node.</em> <a href="#a7">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XSpan::XSpan"></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>
XSpan::XSpan (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXNodeSet.html#s0">BorrowReturnMutableNodeRefList</a> &amp; <em>value</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>
Construct an XSpan object from a node list.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>value</em>
&nbsp;</td><td>
source node list. The instance will adopt the value instance. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="XSpan::XSpan"></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>
XSpan::XSpan (
</b></td>
<td valign="bottom"><b>
const XSpan &amp; <em>source</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>
</td>
</tr>
</table>
<a name="a2" doxytag="XSpan::~XSpan"></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>
XSpan::~XSpan (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="XSpan::getEnd"></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>
int XSpan::getEnd (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the end span offset from start of the last node, or -1 if offset isn't set.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
ending offset </dl> </td>
</tr>
</table>
<a name="a3" doxytag="XSpan::getStart"></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>
int XSpan::getStart (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the start span offset from the first node, or -1 if offset isn't set.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
starting offset </dl> </td>
</tr>
</table>
<a name="a6" doxytag="XSpan::setEnd"></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>
void XSpan::setEnd (
</b></td>
<td valign="bottom"><b>
int <em>end</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the end span offset from start of the last node, or -1 if offset isn't set.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>end</em>
&nbsp;</td><td>
ending offset </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="XSpan::setSpan"></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>
void XSpan::setSpan (
</b></td>
<td valign="bottom"><b>
int <em>firstNodeOffset</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>lastNodeOffset</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the range of the span, based on offsets from the first node and offsets from the last node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>firstNodeOffset</em>
&nbsp;</td><td>
offset of first node </td></tr>
<tr><td valign=top><em>lastNodeOffset</em>
&nbsp;</td><td>
offset of last node </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="XSpan::setStart"></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>
void XSpan::setStart (
</b></td>
<td valign="bottom"><b>
int <em>start</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the start span offset from the first node, or pass -1 if offset isn't set.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>start</em>
&nbsp;</td><td>
starting offset </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSpan_8hpp-source.html">XSpan.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>