<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Xerces-C++: DOMLSParserFilter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Xerces-C++
 <span id="projectnumber">3.1.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related 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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classDOMLSParserFilter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DOMLSParserFilter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Contants</div></td></tr>
<tr class="memitem:adae984d01a925a7d5fe15cef9458a675"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">FilterAction</a> { <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675a370c6c23e1bd0a3f193bbc75cc878f49">FILTER_ACCEPT</a> = 1,
<a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675ac001c32a88ca5f9105a64bc9e8417c14">FILTER_REJECT</a> = 2,
<a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675ab330c9a9dfb16ddad8a742cc77c63ffd">FILTER_SKIP</a> = 3,
<a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675ac74b98bdb82ce615ae42f0be37cc34c5">FILTER_INTERRUPT</a> = 4
}</td></tr>
<tr class="memdesc:adae984d01a925a7d5fe15cef9458a675"><td class="mdescLeft"> </td><td class="mdescRight">Constants returned by acceptNode. <a href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">More...</a><br/></td></tr>
<tr class="separator:adae984d01a925a7d5fe15cef9458a675"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr class="memitem:a53059293ed39579af5c175c930d81726"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#a53059293ed39579af5c175c930d81726">~DOMLSParserFilter</a> ()</td></tr>
<tr class="memdesc:a53059293ed39579af5c175c930d81726"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a53059293ed39579af5c175c930d81726">More...</a><br/></td></tr>
<tr class="separator:a53059293ed39579af5c175c930d81726"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
<tr class="memitem:a95210fc103b33a53ee3af068f6858557"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">FilterAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#a95210fc103b33a53ee3af068f6858557">acceptNode</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *node)=0</td></tr>
<tr class="memdesc:a95210fc103b33a53ee3af068f6858557"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called by the parser at the completion of the parsing of each node. <a href="#a95210fc103b33a53ee3af068f6858557">More...</a><br/></td></tr>
<tr class="separator:a95210fc103b33a53ee3af068f6858557"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5ce215fcce6efa139690ef227f1e729"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">FilterAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#ad5ce215fcce6efa139690ef227f1e729">startElement</a> (<a class="el" href="classDOMElement.html">DOMElement</a> *node)=0</td></tr>
<tr class="memdesc:ad5ce215fcce6efa139690ef227f1e729"><td class="mdescLeft"> </td><td class="mdescRight">The parser will call this method after each <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code> start tag has been scanned, but before the remainder of the <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code> is processed. <a href="#ad5ce215fcce6efa139690ef227f1e729">More...</a><br/></td></tr>
<tr class="separator:ad5ce215fcce6efa139690ef227f1e729"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a829148fd0bca2d569a14766b33b6ff6a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNodeFilter.html#ac1946b252d8fa2ef980280cd94790bf3">DOMNodeFilter::ShowType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#a829148fd0bca2d569a14766b33b6ff6a">getWhatToShow</a> () const =0</td></tr>
<tr class="memdesc:a829148fd0bca2d569a14766b33b6ff6a"><td class="mdescLeft"> </td><td class="mdescRight">Tells the <code><a class="el" href="classDOMLSParser.html" title="DOMLSParser provides an API for parsing XML documents and building the corresponding DOM document tre...">DOMLSParser</a></code> what types of nodes to show to the method <code><a class="el" href="classDOMLSParserFilter.html#a95210fc103b33a53ee3af068f6858557" title="This method will be called by the parser at the completion of the parsing of each node...">DOMLSParserFilter::acceptNode</a></code>. <a href="#a829148fd0bca2d569a14766b33b6ff6a">More...</a><br/></td></tr>
<tr class="separator:a829148fd0bca2d569a14766b33b6ff6a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr class="memitem:a52b5647a16e2e79c0de23f9e9842e6d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMLSParserFilter.html#a52b5647a16e2e79c0de23f9e9842e6d8">DOMLSParserFilter</a> ()</td></tr>
<tr class="separator:a52b5647a16e2e79c0de23f9e9842e6d8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="adae984d01a925a7d5fe15cef9458a675"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">DOMLSParserFilter::FilterAction</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constants returned by acceptNode. </p>
<p><code>FILTER_ACCEPT:</code> Accept the node.</p>
<p><code>FILTER_REJECT:</code> Reject the node and its children.</p>
<p><code>FILTER_SKIP:</code> Skip this single node. The children of this node will still be considered.</p>
<p><code>FILTER_INTERRUPT:</code> Interrupt the normal processing of the document.</p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="adae984d01a925a7d5fe15cef9458a675a370c6c23e1bd0a3f193bbc75cc878f49"></a>FILTER_ACCEPT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="adae984d01a925a7d5fe15cef9458a675ac001c32a88ca5f9105a64bc9e8417c14"></a>FILTER_REJECT</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="adae984d01a925a7d5fe15cef9458a675ab330c9a9dfb16ddad8a742cc77c63ffd"></a>FILTER_SKIP</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="adae984d01a925a7d5fe15cef9458a675ac74b98bdb82ce615ae42f0be37cc34c5"></a>FILTER_INTERRUPT</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a52b5647a16e2e79c0de23f9e9842e6d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DOMLSParserFilter::DOMLSParserFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a53059293ed39579af5c175c930d81726"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual DOMLSParserFilter::~DOMLSParserFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a95210fc103b33a53ee3af068f6858557"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">FilterAction</a> DOMLSParserFilter::acceptNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDOMNode.html">DOMNode</a> * </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method will be called by the parser at the completion of the parsing of each node. </p>
<p>The node and all of its descendants will exist and be complete. The parent node will also exist, although it may be incomplete, i.e. it may have additional children that have not yet been parsed. Attribute nodes are never passed to this function. From within this method, the new node may be freely modified - children may be added or removed, text nodes modified, etc. The state of the rest of the document outside this node is not defined, and the affect of any attempt to navigate to, or to modify any other part of the document is undefined. For validating parsers, the checks are made on the original document, before any modification by the filter. No validity checks are made on any document modifications made by the filter. If this new node is rejected, the parser might reuse the new node and any of its descendants.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The newly constructed element. At the time this method is called, the element is complete - it has all of its children (and their children, recursively) and attributes, and is attached as a child to its parent. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the FilterAction enum </dd></dl>
</div>
</div>
<a class="anchor" id="a829148fd0bca2d569a14766b33b6ff6a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMNodeFilter.html#ac1946b252d8fa2ef980280cd94790bf3">DOMNodeFilter::ShowType</a> DOMLSParserFilter::getWhatToShow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells the <code><a class="el" href="classDOMLSParser.html" title="DOMLSParser provides an API for parsing XML documents and building the corresponding DOM document tre...">DOMLSParser</a></code> what types of nodes to show to the method <code><a class="el" href="classDOMLSParserFilter.html#a95210fc103b33a53ee3af068f6858557" title="This method will be called by the parser at the completion of the parsing of each node...">DOMLSParserFilter::acceptNode</a></code>. </p>
<p>If a node is not shown to the filter using this attribute, it is automatically included in the DOM document being built. See <code><a class="el" href="classDOMNodeFilter.html" title="Filters are objects that know how to "filter out" nodes. ">DOMNodeFilter</a></code> for definition of the constants. The constants SHOW_ATTRIBUTE, SHOW_DOCUMENT, SHOW_DOCUMENT_TYPE, SHOW_NOTATION, SHOW_ENTITY, and SHOW_DOCUMENT_FRAGMENT are meaningless here. Those nodes will never be passed to <a class="el" href="classDOMLSParserFilter.html#a95210fc103b33a53ee3af068f6858557" title="This method will be called by the parser at the completion of the parsing of each node...">DOMLSParserFilter::acceptNode</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>The constants of what types of nodes to show. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div>
</div>
<a class="anchor" id="ad5ce215fcce6efa139690ef227f1e729"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMLSParserFilter.html#adae984d01a925a7d5fe15cef9458a675">FilterAction</a> DOMLSParserFilter::startElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDOMElement.html">DOMElement</a> * </td>
<td class="paramname"><em>node</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The parser will call this method after each <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code> start tag has been scanned, but before the remainder of the <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code> is processed. </p>
<p>The intent is to allow the element, including any children, to be efficiently skipped. Note that only element nodes are passed to the startElement function. The element node passed to startElement for filtering will include all of the attributes, but none of the children nodes. The <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code> may not yet be in place in the document being constructed (it may not have a parent node.) A startElement filter function may access or change the attributes for the <code><a class="el" href="classDOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a></code>. Changing namespace declarations will have no effect on namespace resolution by the parser.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td>The newly encountered element. At the time this method is called, the element is incomplete - it will have its attributes, but no children. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the FilterAction enum </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMLSParserFilter_8hpp_source.html">DOMLSParserFilter.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
21683c2052716543063aae9960d9aef7
>
files
>
502
