blob: 72c897c00b257a4eeb80a4a27540159396f1d93a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>ElemText Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ElemText" --><!-- doxytag: inherits="ElemTemplateElement" -->
<p>This primarily acts as a marker on the element stack to signal that whitespace should be preserved.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ElemText_8hpp_source.html">ElemText.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a>.</p>
<div class="dynheader">
Collaboration diagram for ElemText:</div>
<div class="dyncontent">
<div class="center"><img src="classElemText__coll__graph.png" border="0" usemap="#ElemText_coll__map" alt="Collaboration graph"/></div>
<map name="ElemText_coll__map" id="ElemText_coll__map">
<area shape="rect" id="node2" href="classElemTemplateElement.html" title="ElemTemplateElement" alt="" coords="2263,553,2428,583"/><area shape="rect" id="node25" href="classElemTextLiteral.html" title="ElemTextLiteral" alt="" coords="2843,589,2960,619"/><area shape="rect" id="node43" href="classElemTemplate.html" title="ElemTemplate" alt="" coords="2845,696,2957,725"/><area shape="rect" id="node95" href="classStylesheetRoot.html" title="This acts as the stylesheet root of the stylesheet tree, and holds values that are shared by all styl..." alt="" coords="3721,840,3839,869"/><area shape="rect" id="node4" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs..." alt="" coords="1901,868,2011,897"/><area shape="rect" id="node66" href="classStylesheet.html" title="This class represents the base stylesheet or an &quot;import&quot; stylesheet." alt="" coords="3349,839,3440,868"/><area shape="rect" id="node6" href="classNamespacesHandler.html" title="NamespacesHandler" alt="" coords="1879,668,2033,697"/><area shape="rect" id="node8" href="classXalanVector.html" title="XalanVector\&lt; Namespace \&gt;" alt="" coords="1295,649,1500,679"/><area shape="rect" id="node10" href="classXalanMap.html" title="XalanMap\&lt; const XalanDOMString *, const XalanDOMString * \&gt;" alt="" coords="1180,1028,1615,1057"/><area shape="rect" id="node12" href="classXalanVector.html" title="XalanVector\&lt; BucketType, ConstructWithMemoryManagerTraits\&lt; BucketType \&gt; \&gt;" alt="" coords="433,1465,977,1495"/><area shape="rect" id="node69" href="classXalanMap.html" title="XalanMap\&lt; XalanDOMString, ExtensionNSHandler * \&gt;" alt="" coords="1212,1099,1583,1128"/><area shape="rect" id="node83" href="classXalanMap.html" title="XalanMap\&lt; XalanDOMString, PatternTableVectorType \&gt;" alt="" coords="1208,1268,1587,1297"/><area shape="rect" id="node98" href="classXalanMap.html" title="XalanMap\&lt; const XalanQName *, AttributeSetVectorType \&gt;" alt="" coords="1193,1603,1601,1632"/><area shape="rect" id="node109" href="classXalanMap.html" title="XalanMap\&lt; XalanQNameByReference, const ElemTemplate * \&gt;" alt="" coords="1183,1441,1612,1471"/><area shape="rect" id="node14" href="structXalanMapKeyTraits_3_01const_01XalanDOMString_01_5_01_4.html" title="XalanMapKeyTraits\&lt; const XalanDOMString * \&gt;" alt="" coords="541,929,869,959"/><area shape="rect" id="node16" href="classXalanList.html" title="XalanList\&lt; Entry \&gt;" alt="" coords="633,1304,777,1333"/><area shape="rect" id="node18" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="44,1304,225,1333"/><area shape="rect" id="node21" href="classXalanVector.html" title="XalanVector\&lt; const XalanDOMString * \&gt;" alt="" coords="1255,703,1540,732"/><area shape="rect" id="node23" href="classXalanVector.html" title="XalanVector\&lt; NamespaceExtended \&gt;" alt="" coords="1264,596,1531,625"/><area shape="rect" id="node28" href="classXalanQNameByReference.html" title="XalanQNameByReference" alt="" coords="1863,320,2049,349"/><area shape="rect" id="node30" href="classXalanQName.html" title="Class to represent a qualified name." alt="" coords="1344,373,1451,403"/><area shape="rect" id="node32" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="641,373,769,403"/><area shape="rect" id="node37" href="classElemTemplateElement_1_1LocatorProxy.html" title="ElemTemplateElement::LocatorProxy" alt="" coords="1269,543,1525,572"/><area shape="rect" id="node46" href="classXPath.html" title="XPath" alt="" coords="1925,760,1987,789"/><area shape="rect" id="node54" href="classXPathExpression.html" title="XPathExpression" alt="" coords="1332,756,1463,785"/><area shape="rect" id="node121" href="classXalanNamespace.html" title="XalanNamespace" alt="" coords="1329,237,1465,267"/><area shape="rect" id="node34" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="21,373,248,403"/><area shape="rect" id="node39" href="classXalanLocator.html" title="This class defines a base class for Locator derivations in Xalan." alt="" coords="652,552,759,581"/><area shape="rect" id="node48" href="classXPathFunctionTable.html" title="Class defines a table of functions that can be called in XPath expresions." alt="" coords="1324,821,1471,851"/><area shape="rect" id="node50" href="classFunction.html" title="Function" alt="" coords="668,799,743,828"/><area shape="rect" id="node52" href="structXPathFunctionTable_1_1FunctionNameTableEntry.html" title="XPathFunctionTable::FunctionNameTableEntry" alt="" coords="548,864,863,893"/><area shape="rect" id="node56" href="classXalanVector.html" title="XalanVector\&lt; XToken \&gt;" alt="" coords="617,739,793,768"/><area shape="rect" id="node58" href="classXalanVector.html" title="XalanVector\&lt; int \&gt;" alt="" coords="632,632,779,661"/><area shape="rect" id="node60" href="classXalanVector.html" title="XalanVector\&lt; double \&gt;" alt="" coords="619,685,792,715"/><area shape="rect" id="node73" href="structXalanMapKeyTraits_3_01XalanDOMString_01_4.html" title="XalanMapKeyTraits\&lt; XalanDOMString \&gt;" alt="" coords="567,1028,844,1057"/><area shape="rect" id="node76" href="classXalanVector.html" title="XalanVector\&lt; Stylesheet * \&gt;" alt="" coords="2797,536,3005,565"/><area shape="rect" id="node78" href="classXalanVector.html" title="XalanVector\&lt; ElemVariable * \&gt;" alt="" coords="2789,1025,3013,1055"/><area shape="rect" id="node81" href="classXalanVector.html" title="XalanVector\&lt; XalanSpaceNodeTester \&gt;" alt="" coords="2761,643,3041,672"/><area shape="rect" id="node88" href="classXalanVector.html" title="XalanVector\&lt; Type, ConstructionTraits \&gt;" alt="" coords="2760,755,3043,784"/><area shape="rect" id="node90" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMString \&gt;" alt="" coords="2784,1129,3019,1159"/><area shape="rect" id="node93" href="classXalanVector.html" title="XalanVector\&lt; ElemDecimalFormat * \&gt;" alt="" coords="2767,1183,3036,1212"/><area shape="rect" id="node100" href="structXalanMapKeyTraits_3_01const_01XalanQName_01_5_01_4.html" title="XalanMapKeyTraits\&lt; const XalanQName * \&gt;" alt="" coords="551,1757,860,1787"/><area shape="rect" id="node106" href="classXalanVector.html" title="XalanVector\&lt; const XalanQName * \&gt;" alt="" coords="3261,1348,3528,1377"/><area shape="rect" id="node112" href="structXalanMapKeyTraits_3_01XalanQNameByReference_01_4.html" title="XalanMapKeyTraits\&lt; XalanQNameByReference \&gt;" alt="" coords="536,1692,875,1721"/><area shape="rect" id="node114" href="structXalanMapKeyTraits_3_01XalanQName_01_4.html" title="XalanMapKeyTraits\&lt; XalanQName \&gt;" alt="" coords="5,1692,264,1721"/><area shape="rect" id="node117" href="classXalanDeque.html" title="Xalan implementation of deque." alt="" coords="2453,252,2736,281"/><area shape="rect" id="node119" href="classXalanVector.html" title="XalanVector\&lt; BlockType * \&gt;" alt="" coords="1855,247,2057,276"/><area shape="rect" id="node124" href="classXalanVector.html" title="XalanVector\&lt; KeyDeclaration \&gt;" alt="" coords="2788,379,3015,408"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classElemText-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classElemText.html#a13ea059ce72512cf56cb98406979e85c">ElemText</a> (<a class="el" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a> &amp;constructionContext, <a class="el" href="classStylesheet.html">Stylesheet</a> &amp;stylesheetTree, const <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab5db67e0ad48b82d8a0476b99c377fdb">AttributeListType</a> &amp;atts, XalanFileLoc lineNumber, XalanFileLoc columnNumber)
<dl class="el"><dd class="mdescRight">Construct an object corresponding to an "xsl:text" element. <a href="#a13ea059ce72512cf56cb98406979e85c"></a><br/></dl><li>virtual <a class="el" href="classElemText.html#a5eaa3beb09c8fc032eb772f0e0712bb0">~ElemText</a> ()
<li>bool <a class="el" href="classElemText.html#a22e5c04a0ecce2e18d70805a840053a9">getDisableOutputEscaping</a> () const
<dl class="el"><dd class="mdescRight">Determine whether output escaping should be disabled. <a href="#a22e5c04a0ecce2e18d70805a840053a9"></a><br/></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classElemText.html#abd4028f7b8bf3fa97130e6edf0de6622">getElementName</a> () const
<dl class="el"><dd class="mdescRight">Get a string for the name of the element. <a href="#abd4028f7b8bf3fa97130e6edf0de6622"></a><br/></dl></ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual bool <a class="el" href="classElemText.html#aec3cfc81be0bd65ffe9b56dfb7fce034">childTypeAllowed</a> (int xslToken) const
<dl class="el"><dd class="mdescRight">Given an xsl token type, determine whether or not a child of that type is allowed. <a href="#aec3cfc81be0bd65ffe9b56dfb7fce034"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This primarily acts as a marker on the element stack to signal that whitespace should be preserved. </p>
<p>Definition at line <a class="el" href="ElemText_8hpp_source.html#l00040">40</a> of file <a class="el" href="ElemText_8hpp_source.html">ElemText.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a13ea059ce72512cf56cb98406979e85c"></a><!-- doxytag: member="ElemText::ElemText" ref="a13ea059ce72512cf56cb98406979e85c" args="(StylesheetConstructionContext &amp;constructionContext, Stylesheet &amp;stylesheetTree, const AttributeListType &amp;atts, XalanFileLoc lineNumber, XalanFileLoc columnNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ElemText::ElemText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStylesheetConstructionContext.html">StylesheetConstructionContext</a> &amp;&nbsp;</td>
<td class="paramname"> <em>constructionContext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classStylesheet.html">Stylesheet</a> &amp;&nbsp;</td>
<td class="paramname"> <em>stylesheetTree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab5db67e0ad48b82d8a0476b99c377fdb">AttributeListType</a> &amp;&nbsp;</td>
<td class="paramname"> <em>atts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>lineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>columnNumber</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an object corresponding to an "xsl:text" element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>constructionContext</em>&nbsp;</td><td>context for construction of object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stylesheetTree</em>&nbsp;</td><td>stylesheet containing element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>atts</em>&nbsp;</td><td>list of attributes for element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lineNumber</em>&nbsp;</td><td>line number in document </td></tr>
<tr><td valign="top"></td><td valign="top"><em>columnNumber</em>&nbsp;</td><td>column number in document </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5eaa3beb09c8fc032eb772f0e0712bb0"></a><!-- doxytag: member="ElemText::~ElemText" ref="a5eaa3beb09c8fc032eb772f0e0712bb0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ElemText::~ElemText </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aec3cfc81be0bd65ffe9b56dfb7fce034"></a><!-- doxytag: member="ElemText::childTypeAllowed" ref="aec3cfc81be0bd65ffe9b56dfb7fce034" args="(int xslToken) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ElemText::childTypeAllowed </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>xslToken</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given an xsl token type, determine whether or not a child of that type is allowed. </p>
<p>This is so derived types can determine whether a particular type of child is allowed for the instance. It is called from <a class="el" href="classElemTemplateElement.html#a7a3f9e904a8d5ec667fb268abf5f6261" title="Append a child.">appendChildElem()</a>.</p>
<p>The default is to allow no types (no children)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xslToken</em>&nbsp;</td><td>The xsl token value of the child.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the child is allowed, or false if not. </dd></dl>
<p>Reimplemented from <a class="el" href="classElemTemplateElement.html#acedce7575fd98a65e3243242d303bc4b">ElemTemplateElement</a>.</p>
</div>
</div>
<a class="anchor" id="a22e5c04a0ecce2e18d70805a840053a9"></a><!-- doxytag: member="ElemText::getDisableOutputEscaping" ref="a22e5c04a0ecce2e18d70805a840053a9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ElemText::getDisableOutputEscaping </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine whether output escaping should be disabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if output escaping disabled </dd></dl>
<p>Definition at line <a class="el" href="ElemText_8hpp_source.html#l00069">69</a> of file <a class="el" href="ElemText_8hpp_source.html">ElemText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="abd4028f7b8bf3fa97130e6edf0de6622"></a><!-- doxytag: member="ElemText::getElementName" ref="abd4028f7b8bf3fa97130e6edf0de6622" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; ElemText::getElementName </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a string for the name of the element. </p>
<p>Useful for debugging purposes, and error reporting.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A string containing the name of the element. </dd></dl>
<p>Implements <a class="el" href="classElemTemplateElement.html#a781239726cc49828a0a493f1d47ee60e">ElemTemplateElement</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ElemText_8hpp_source.html">ElemText.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>