File: Poco.XML.Attributes.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 (120 lines) | stat: -rw-r--r-- 11,157 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
<!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::Attributes</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 Attributes</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> SAX<br />
<b>Header:</b> Poco/SAX/Attributes.h</p>
<h2>Description</h2>
<div class="description">
<p>Interface for a list of <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> attributes. This interface allows access to a list of attributes in three different ways: </p>
<ol>
<li>by attribute index;  </li>
<li>by Namespace-qualified name; or  </li>
<li>by qualified (prefixed) name.  </li>
</ol>
<p>The list will not contain attributes that were declared #IMPLIED but not  specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the  <a href="http://xml.org/sax/features/namespace-prefixes" target="_blank">http://xml.org/sax/features/namespace-prefixes</a> feature is set to true (it is false by default). </p>
<p>If the namespace-prefixes feature (see above) is false, access by  qualified name may not be available; if the <a href="http://xml.org/sax/features/namespaces" target="_blank">http://xml.org/sax/features/namespaces</a> feature is false, access by  Namespace-qualified names may not be available. This interface replaces the now-deprecated SAX1 AttributeList interface,  which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below). The order of attributes in the list is unspecified, and will vary from  implementation to implementation. </p>
</div>
<h2>Inheritance</h2>
<p><b>Known Derived Classes: </b><a href="Poco.XML.AttributesImpl.html" title="class Poco::XML::AttributesImpl">AttributesImpl</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.Attributes.html#18702" title="Poco::XML::Attributes::getIndex()">getIndex</a>, <a href="Poco.XML.Attributes.html#18707" title="Poco::XML::Attributes::getLength()">getLength</a>, <a href="Poco.XML.Attributes.html#18708" title="Poco::XML::Attributes::getLocalName()">getLocalName</a>, <a href="Poco.XML.Attributes.html#18710" title="Poco::XML::Attributes::getQName()">getQName</a>, <a href="Poco.XML.Attributes.html#18712" title="Poco::XML::Attributes::getType()">getType</a>, <a href="Poco.XML.Attributes.html#18726" title="Poco::XML::Attributes::getURI()">getURI</a>, <a href="Poco.XML.Attributes.html#18719" title="Poco::XML::Attributes::getValue()">getValue</a></p>
<h2>Destructor</h2>
<h3><a name="18728">~Attributes</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.XML.Attributes.html" title="class Poco::XML::Attributes">Attributes</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18702">getIndex</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual int getIndex(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; name<br />) const = 0;</p>
<div class="description">
<p>Look up the index of an attribute by a qualified name. </p>
</div>
<h3><a name="18704">getIndex</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual int getIndex(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; namespaceURI,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; localName<br />) const = 0;</p>
<div class="description">
<p>Look up the index of an attribute by a namspace name. </p>
</div>
<h3><a name="18707">getLength</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual int getLength() const = 0;</p>
<div class="description">
<p>Return the number of attributes in the list. </p>
<p>Once you know the number of attributes, you can iterate through the list. </p>
</div>
<h3><a name="18708">getLocalName</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getLocalName(<br />&nbsp;&nbsp;&nbsp;&nbsp;int i<br />) const = 0;</p>
<div class="description">
<p>Look up a local attribute name by index. </p>
</div>
<h3><a name="18710">getQName</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getQName(<br />&nbsp;&nbsp;&nbsp;&nbsp;int i<br />) const = 0;</p>
<div class="description">
<p>Look up a qualified attribute name by index. </p>
</div>
<h3><a name="18712">getType</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getType(<br />&nbsp;&nbsp;&nbsp;&nbsp;int i<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute type by index. </p>
<p>The attribute type is one of the strings &quot;CDATA&quot;, &quot;ID&quot;, &quot;IDREF&quot;, &quot;IDREFS&quot;, &quot;NMTOKEN&quot;,  &quot;NMTOKENS&quot;, &quot;ENTITY&quot;, &quot;ENTITIES&quot;, or &quot;NOTATION&quot; (always in upper case). </p>
<p>If the parser has not read a declaration for the attribute, or if the parser does not  report attribute types, then it must return the value &quot;CDATA&quot; as stated in the <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> 1.0  Recommendation (clause 3.3.3, &quot;Attribute-Value Normalization&quot;). </p>
<p>For an enumerated attribute that is not a notation, the parser will report the type  as &quot;NMTOKEN&quot;. </p>
</div>
<h3><a name="18714">getType</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getType(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; qname<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute type by a qualified name. </p>
<p>See <a href="Poco.XML.Attributes.html#18712" title="Poco::XML::Attributes::getType()">getType</a>(int) for a description of the possible types. </p>
</div>
<h3><a name="18716">getType</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getType(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; namespaceURI,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; localName<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute type by a namespace name. </p>
<p>See <a href="Poco.XML.Attributes.html#18712" title="Poco::XML::Attributes::getType()">getType</a>(int) for a description of the possible types. </p>
</div>
<h3><a name="18726">getURI</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getURI(<br />&nbsp;&nbsp;&nbsp;&nbsp;int i<br />) const = 0;</p>
<div class="description">
<p>Look up a namespace <a href="Poco.URI.html" title="class Poco::URI">URI</a> by index. </p>
</div>
<h3><a name="18719">getValue</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getValue(<br />&nbsp;&nbsp;&nbsp;&nbsp;int i<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute value by index. </p>
<p>If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens  will be concatenated into a single string with each token separated by a single space. </p>
</div>
<h3><a name="18721">getValue</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getValue(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; qname<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute value by a qualified name. </p>
<p>See <a href="Poco.XML.Attributes.html#18719" title="Poco::XML::Attributes::getValue()">getValue</a>(int) for a description of the possible values. </p>
</div>
<h3><a name="18723">getValue</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getValue(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; uri,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; localName<br />) const = 0;</p>
<div class="description">
<p>Look up an attribute value by a namespace name. </p>
<p>See <a href="Poco.XML.Attributes.html#18719" title="Poco::XML::Attributes::getValue()">getValue</a>(int) for a description of the possible values. </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>