Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > by-pkgid > 5e43f5d92fadaa0a1cc4664249b615d0 > files > 2475

xalan-c-doc-1.1-8mdk.i586.rpm

<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSL Transformer Version 1.1</h3>
</BODY>
<!-- Generated by Doxygen 1.2.0 on Thu Feb 15 10:50:08 2001 -->
<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>XNodeSet  Class Reference</h1>Class to hold <a class="el" href="class_xpath.html">XPath</a> return types. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XNodeSet.hpp-source.html">XNodeSet.hpp</a>&gt;</code>
<p>
Inheritance diagram for XNodeSet<p><center><img src="class_xnodeset_inherit_graph.gif" border="0" usemap="#XNodeSet_inherit_map" alt="Inheritance graph"></center>
<map name="XNodeSet_inherit_map">
<area href="class_xspan.html" shape="rect" coords="65,199,113,218">
<area href="class_xobject.html" shape="rect" coords="60,66,119,85">
<area href="class_xalanreferencecountedobject.html" shape="rect" coords="0,-1,179,18">
</map><p>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XNodeSet:<p><center><img src="class_xnodeset_coll_graph.gif" border="0" usemap="#XNodeSet_coll_map" alt="Collaboration graph"></center>
<map name="XNodeSet_coll_map">
<area href="class_xobject.html" shape="rect" coords="181,83,240,101">
<area href="class_xalanreferencecountedobject.html" shape="rect" coords="285,0,464,19">
<area href="class_xalandomstring.html" shape="rect" coords="0,0,109,19">
<area href="class_xobjectfactory.html" shape="rect" coords="163,0,261,19">
<area href="class_xalanautoptr.html" shape="rect" coords="264,83,475,101">
<area href="class_xpathexecutioncontext.html" shape="rect" coords="499,83,640,101">
<area href="class_executioncontext.html" shape="rect" coords="515,0,624,19">
</map><p>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_xnodeset-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XPathExecutionContext::BorrowReturnMutableNodeRefList <a class="el" href="class_xnodeset.html#s0">BorrowReturnMutableNodeRefList</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="class_xnodeset.html#a0">XNodeSet</a> (<a class="el" href="class_xnodeset.html#s0">BorrowReturnMutableNodeRefList</a>&amp; value)
<dl class="el"><dd><font size=-1><em>Create an XNodeSet from a node list.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="class_xnodeset.html#a1">XNodeSet</a> ( const XNodeSet&amp; source, bool deepClone = false)
<dl class="el"><dd><font size=-1><em>Create an XNodeSet from another.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="class_xnodeset.html#a2">~XNodeSet</a> ()
<li>virtual XNodeSet* <a class="el" href="class_xnodeset.html#a3">clone</a> (void* theAddress = 0) const
<dl class="el"><dd><font size=-1><em>Clone the instance.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="class_xalandomstring.html">XalanDOMString</a> <a class="el" href="class_xnodeset.html#a4">getTypeString</a> () const
<dl class="el"><dd><font size=-1><em>Given a request type, return the equivalent string.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual double <a class="el" href="class_xnodeset.html#a5">num</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a number.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="class_xnodeset.html#a6">boolean</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a boolean.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="class_xalandomstring.html">XalanDOMString</a>&amp; <a class="el" href="class_xnodeset.html#a7">str</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a string.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="class_resulttreefragbase.html">ResultTreeFragBase</a>&amp; <a class="el" href="class_xnodeset.html#a8">rtree</a> (<a class="el" href="class_xpathexecutioncontext.html">XPathExecutionContext</a>&amp; executionContext) const
<dl class="el"><dd><font size=-1><em>Cast result object to a result tree fragment.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="class_nodereflistbase.html">NodeRefListBase</a>&amp; <a class="el" href="class_xnodeset.html#a9">nodeset</a> () const
<dl class="el"><dd><font size=-1><em>Cast result object to a nodelist.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="class_xnodeset.html#a10">ProcessXObjectTypeCallback</a> (<a class="el" href="class_xobjecttypecallback.html">XObjectTypeCallback</a>&amp; theCallbackObject)
<dl class="el"><dd><font size=-1><em>Process a callback request for preferred type information.</em> <a href="#a10">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="class_xnodeset.html#a11">ProcessXObjectTypeCallback</a> (<a class="el" href="class_xobjecttypecallback.html">XObjectTypeCallback</a>&amp; theCallbackObject) const
<dl class="el"><dd><font size=-1><em>Process a callback request for preferred type information.</em> <a href="#a11">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="class_xnodeset.html#a12">release</a> ()
<dl class="el"><dd><font size=-1><em>Release the node set held by the instance.<br><br></em></font></dl><li>void <a class="el" href="class_xnodeset.html#a13">set</a> (<a class="el" href="class_xnodeset.html#s0">BorrowReturnMutableNodeRefList</a>&amp; value)
<dl class="el"><dd><font size=-1><em>Change the value of an XNodeSet.</em> <a href="#a13">More...</a><em><br><br></em></font></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to hold <a class="el" href="class_xpath.html">XPath</a> return types.
<p>

<p>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XNodeSet::BorrowReturnMutableNodeRefList"></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> 
typedef XPathExecutionContext::BorrowReturnMutableNodeRefList XNodeSet::BorrowReturnMutableNodeRefList
          </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>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XNodeSet::XNodeSet"></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> 
XNodeSet::XNodeSet (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_xnodeset.html#s0">BorrowReturnMutableNodeRefList</a> &amp; <em>value</em>&nbsp;)
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create an XNodeSet 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>
 Pointer to source node list. The XNodeSet will adopt the pointer. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a1" doxytag="XNodeSet::XNodeSet"></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> 
XNodeSet::XNodeSet (
          </b></td>
          <td valign="bottom"><b>
const XNodeSet &amp; <em>source</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
bool <em>deepClone</em> = false&nbsp;)
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create an XNodeSet from another.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em>
&nbsp;</td><td>
 object to copy </td></tr>
<tr><td valign=top><em>deepClone</em>
&nbsp;</td><td>
 true to copy all children on nodeset nodes </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a2" doxytag="XNodeSet::~XNodeSet"></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> 
virtual XNodeSet::~XNodeSet (
          </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="a11" doxytag="XNodeSet::ProcessXObjectTypeCallback"></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> 
virtual void XNodeSet::ProcessXObjectTypeCallback (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_xobjecttypecallback.html">XObjectTypeCallback</a> &amp; <em>theCallbackObject</em>&nbsp;) const<code> [virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Process a callback request for preferred type information.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theCallbackObject</em>
&nbsp;</td><td>
 object to call back </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a10">XObject</a>.    </td>
  </tr>
</table>
<a name="a10" doxytag="XNodeSet::ProcessXObjectTypeCallback"></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> 
virtual void XNodeSet::ProcessXObjectTypeCallback (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_xobjecttypecallback.html">XObjectTypeCallback</a> &amp; <em>theCallbackObject</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>
Process a callback request for preferred type information.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theCallbackObject</em>
&nbsp;</td><td>
 object to call back </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a9">XObject</a>.    </td>
  </tr>
</table>
<a name="a6" doxytag="XNodeSet::boolean"></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> 
virtual bool XNodeSet::boolean (
          </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>
Cast result object to a boolean.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 boolean value </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a5">XObject</a>.    </td>
  </tr>
</table>
<a name="a3" doxytag="XNodeSet::clone"></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> 
virtual XNodeSet* XNodeSet::clone (
          </b></td>
          <td valign="bottom"><b>
void * <em>theAddress</em> = 0&nbsp;) const<code> [virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clone the instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>If</em>
&nbsp;</td><td>
 theAddress is not null, the <a class="el" href="class_xobject.html">XObject</a> will clone itself into that address. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 a clone of the instance. </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a2">XObject</a>.
<p>
Reimplemented in <a class="el" href="class_xspan.html#a3">XSpan</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="XNodeSet::getTypeString"></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> 
virtual <a class="el" href="class_xalandomstring.html">XalanDOMString</a> XNodeSet::getTypeString (
          </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>
Given a request type, return the equivalent string.
<p>
For diagnostic purposes.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 string for type </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a3">XObject</a>.    </td>
  </tr>
</table>
<a name="a9" doxytag="XNodeSet::nodeset"></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> 
virtual const <a class="el" href="class_nodereflistbase.html">NodeRefListBase</a>&amp; XNodeSet::nodeset (
          </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>
Cast result object to a nodelist.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 node list </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a8">XObject</a>.    </td>
  </tr>
</table>
<a name="a5" doxytag="XNodeSet::num"></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> 
virtual double XNodeSet::num (
          </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>
Cast result object to a number.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 numeric value </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a4">XObject</a>.    </td>
  </tr>
</table>
<a name="a12" doxytag="XNodeSet::release"></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 XNodeSet::release (
          </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>
Release the node set held by the instance.
<p>
    </td>
  </tr>
</table>
<a name="a8" doxytag="XNodeSet::rtree"></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> 
virtual const <a class="el" href="class_resulttreefragbase.html">ResultTreeFragBase</a>&amp; XNodeSet::rtree (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_xpathexecutioncontext.html">XPathExecutionContext</a> &amp; <em>executionContext</em>&nbsp;) const<code> [virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Cast result object to a result tree fragment.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>executionContext</em>
&nbsp;</td><td>
 the current execution context </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
 result tree fragment </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a7">XObject</a>.    </td>
  </tr>
</table>
<a name="a13" doxytag="XNodeSet::set"></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 XNodeSet::set (
          </b></td>
          <td valign="bottom"><b>
<a class="el" href="class_xnodeset.html#s0">BorrowReturnMutableNodeRefList</a> &amp; <em>value</em>&nbsp;)
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Change the value of an XNodeSet.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theValue</em>
&nbsp;</td><td>
 The new value. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a7" doxytag="XNodeSet::str"></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> 
virtual const <a class="el" href="class_xalandomstring.html">XalanDOMString</a>&amp; XNodeSet::str (
          </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>
Cast result object to a string.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
 string value </dl>
<p>
Reimplemented from <a class="el" href="class_xobject.html#a6">XObject</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XNodeSet.hpp-source.html">XNodeSet.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="images/dot.gif" width="1"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
	<TR>
		<TD WIDTH="80%" VALIGN="TOP">
			<P ALIGN="CENTER"><B>Xalan-C++ XSL Transformer Version 1.1</B><BR>
			Copyright &copy; 2000, 2001 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">
		</TD>
	</TR>
</TABLE>