File: Poco.XML.DeclHandler.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 (69 lines) | stat: -rw-r--r-- 7,784 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
<!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::DeclHandler</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 DeclHandler</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> SAX<br />
<b>Header:</b> Poco/SAX/DeclHandler.h</p>
<h2>Description</h2>
<div class="description">
<p>This is an optional extension handler for SAX2 to provide information  about DTD declarations in an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> document. <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> readers are not required to support this handler, and this handler is  not included in the core SAX2 distribution. </p>
<p>Note that data-related DTD declarations (unparsed entities and notations)  are already reported through the <a href="Poco.XML.DTDHandler.html" title="class Poco::XML::DTDHandler">DTDHandler</a> interface. If you are using the declaration handler together with a lexical handler,  all of the events will occur between the startDTD and the endDTD events. To set the <a href="Poco.XML.DeclHandler.html" title="class Poco::XML::DeclHandler">DeclHandler</a> for an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> reader, use the setProperty method  with the propertyId &quot;<a href="http://xml.org/sax/properties/declaration-handler"" target="_blank">http://xml.org/sax/properties/declaration-handler"</a>.  If the reader does not support declaration events, it will throw a <a href="Poco.XML.SAXNotRecognizedException.html" title="class Poco::XML::SAXNotRecognizedException">SAXNotRecognizedException</a> or a <a href="Poco.XML.SAXNotSupportedException.html" title="class Poco::XML::SAXNotSupportedException">SAXNotSupportedException</a> when you attempt to  register the handler. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.DeclHandler.html#18896" title="Poco::XML::DeclHandler::attributeDecl()">attributeDecl</a>, <a href="Poco.XML.DeclHandler.html#18901" title="Poco::XML::DeclHandler::elementDecl()">elementDecl</a>, <a href="Poco.XML.DeclHandler.html#18904" title="Poco::XML::DeclHandler::externalEntityDecl()">externalEntityDecl</a>, <a href="Poco.XML.DeclHandler.html#18908" title="Poco::XML::DeclHandler::internalEntityDecl()">internalEntityDecl</a></p>
<h2>Destructor</h2>
<h3><a name="18911">~DeclHandler</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.DeclHandler.html" title="class Poco::XML::DeclHandler">DeclHandler</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18896">attributeDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void attributeDecl(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; eName,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; aName,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> * valueDefault,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> * value<br />) = 0;</p>
<div class="description">
<p>Report an attribute type declaration. </p>
<p>Only the effective (first) declaration for an attribute will be reported.  The type will be 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;, a parenthesized token group  with the separator &quot;|&quot; and all whitespace removed, or the word &quot;NOTATION&quot;  followed by a space followed by a parenthesized token group with all whitespace  removed. </p>
<p>The value will be the value as reported to applications, appropriately normalized  and with entity and character references expanded.  </p>
</div>
<h3><a name="18901">elementDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void elementDecl(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; model<br />) = 0;</p>
<div class="description">
<p>Report an element type declaration. </p>
<p>The content model will consist of the string &quot;EMPTY&quot;, the string &quot;ANY&quot;, or a  parenthesised group, optionally followed by an occurrence indicator. The model  will be normalized so that all parameter entities are fully resolved and all  whitespace is removed,and will include the enclosing parentheses. Other  normalization (such as removing redundant parentheses or simplifying occurrence  indicators) is at the discretion of the parser. </p>
</div>
<h3><a name="18904">externalEntityDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void externalEntityDecl(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> * publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId<br />) = 0;</p>
<div class="description">
<p>Report an external entity declaration. </p>
<p>Only the effective (first) declaration for each entity will be reported. </p>
<p>If the system identifier is a URL, the parser must resolve it fully before  passing it to the application. </p>
</div>
<h3><a name="18908">internalEntityDecl</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void internalEntityDecl(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; value<br />) = 0;</p>
<div class="description">
<p>Report an internal entity declaration. </p>
<p>Only the effective (first) declaration for each entity will be reported. All  parameter entities in the value will be expanded, but general entities will not. </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>