File: Poco.XML.NodeIterator.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (124 lines) | stat: -rw-r--r-- 11,979 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<!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>
<title>Class Poco::XML::NodeIterator</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class NodeIterator</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/NodeIterator.h</p>
<h2>Description</h2>
<div class="description">
<p>Iterators are used to step through a set of nodes, e.g. the set of nodes in a <a href="Poco.XML.NodeList.html" title="class Poco::XML::NodeList">NodeList</a>, the document subtree governed by a particular <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a>, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>. DOM Level 2 specifies a single <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> implementation for document-order traversal of a document subtree. </p>
<p>A <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> can be directly instantiated using one of its constructors - the DocumentTraversal interface is not needed and therefore not implemented. Unlike most other DOM classes, <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> supports value semantics. </p>
<p>If the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>'s current node is removed from the document, the result of calling any of the movement methods is undefined. This behavior does not conform to the DOM Level 2 Traversal specification. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.NodeIterator.html#18589" title="Poco::XML::NodeIterator::accept()">accept</a>, <a href="Poco.XML.NodeIterator.html#18587" title="Poco::XML::NodeIterator::currentNodeNP()">currentNodeNP</a>, <a href="Poco.XML.NodeIterator.html#18588" title="Poco::XML::NodeIterator::detach()">detach</a>, <a href="Poco.XML.NodeIterator.html#18584" title="Poco::XML::NodeIterator::expandEntityReferences()">expandEntityReferences</a>, <a href="Poco.XML.NodeIterator.html#18583" title="Poco::XML::NodeIterator::filter()">filter</a>, <a href="Poco.XML.NodeIterator.html#18593" title="Poco::XML::NodeIterator::last()">last</a>, <a href="Poco.XML.NodeIterator.html#18591" title="Poco::XML::NodeIterator::next()">next</a>, <a href="Poco.XML.NodeIterator.html#18585" title="Poco::XML::NodeIterator::nextNode()">nextNode</a>, <a href="Poco.XML.NodeIterator.html#18578" title="Poco::XML::NodeIterator::operator =()">operator&nbsp;=</a>, <a href="Poco.XML.NodeIterator.html#18592" title="Poco::XML::NodeIterator::previous()">previous</a>, <a href="Poco.XML.NodeIterator.html#18586" title="Poco::XML::NodeIterator::previousNode()">previousNode</a>, <a href="Poco.XML.NodeIterator.html#18581" title="Poco::XML::NodeIterator::root()">root</a>, <a href="Poco.XML.NodeIterator.html#18582" title="Poco::XML::NodeIterator::whatToShow()">whatToShow</a></p>
<h2>Constructors</h2>
<h3><a name="18576">NodeIterator</a></h3>
<p class="decl"><a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> &amp; iterator<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> by copying another <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>. </p>
</div>
<h3><a name="18572">NodeIterator</a></h3>
<p class="decl"><a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * root,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long whatToShow,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.NodeFilter.html" title="class Poco::XML::NodeFilter">NodeFilter</a> * pFilter = 0<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> over the subtree rooted at the specified node. </p>
</div>
<h2>Destructor</h2>
<h3><a name="18580">~NodeIterator</a></h3>
<p class="decl">~<a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="18587">currentNodeNP</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * currentNodeNP() const;</p>
<div class="description">
<p>Returns the current node in the set. </p>
<p>Leaves the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> unchanged. </p>
<p>Warning: This is a proprietary extension to the DOM Level 2 <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> interface. </p>
</div>
<h3><a name="18588">detach</a></h3>
<p class="decl">void detach();</p>
<div class="description">
<p>Detaches the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR. </p>
</div>
<h3><a name="18584">expandEntityReferences</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool expandEntityReferences() const;</p>
<div class="description">
<p>The value of this flag determines whether the children of entity reference nodes are visible to the iterator. If false, they and their descendants will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes. </p>
<p>To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the iterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false. </p>
<p>This implementation does not support entity reference expansion and thus always returns false. </p>
</div>
<h3><a name="18583">filter</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.NodeFilter.html" title="class Poco::XML::NodeFilter">NodeFilter</a> * filter() const;</p>
<div class="description">
<p>The <a href="Poco.XML.NodeFilter.html" title="class Poco::XML::NodeFilter">NodeFilter</a> used to screen nodes. </p>
</div>
<h3><a name="18585">nextNode</a></h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * nextNode();</p>
<div class="description">
<p>Returns the next node in the set and advances the position of the iterator in the set. After a <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> is created, the first call to <a href="Poco.XML.NodeIterator.html#18585" title="Poco::XML::NodeIterator::nextNode()">nextNode</a>() returns the first node in the set. </p>
</div>
<h3><a name="18578">operator =</a></h3>
<p class="decl"><a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> &amp; iterator<br />);</p>
<div class="description">
<p>Assignment operator. </p>
</div>
<h3><a name="18586">previousNode</a></h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * previousNode();</p>
<div class="description">
<p>Returns the previous node in the set and moves the position of the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a> backwards in the set. </p>
</div>
<h3><a name="18581">root</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * root() const;</p>
<div class="description">
<p>The root node of the <a href="Poco.XML.NodeIterator.html" title="class Poco::XML::NodeIterator">NodeIterator</a>, as specified when it was created. </p>
</div>
<h3><a name="18582">whatToShow</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">unsigned long whatToShow() const;</p>
<div class="description">
<p>This attribute determines which node types are presented via the iterator.  The available set of constants is defined in the <a href="Poco.XML.NodeFilter.html" title="class Poco::XML::NodeFilter">NodeFilter</a> interface.  Nodes not accepted by whatToShow will be skipped, but their children may  still be considered. Note that this skip takes precedence over the filter,  if any. </p>
</div>
<h3><a name="18589">accept</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool accept(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * pNode<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18593">last</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * last();</p>
<div class="description">
<p></p>
</div>
<h3><a name="18591">next</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * next() const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18592">previous</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * previous() const;</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>