You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqt3/doc/html/tqxmldeclhandler.html

124 lines
7.1 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQXmlDeclHandler Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQXmlDeclHandler Class Reference<br><small>[<a href="xml.html">XML module</a>]</small></h1>
<p>The TQXmlDeclHandler class provides an interface to report declaration
content of XML data.
<a href="#details">More...</a>
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when TQt is built with thread support.</p>
<p><tt>#include &lt;<a href="tqxml-h.html">tqxml.h</a>&gt;</tt>
<p>Inherited by <a href="tqxmldefaulthandler.html">TQXmlDefaultHandler</a>.
<p><a href="tqxmldeclhandler-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>virtual bool <a href="#attributeDecl"><b>attributeDecl</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;eName, const&nbsp;TQString&nbsp;&amp;&nbsp;aName, const&nbsp;TQString&nbsp;&amp;&nbsp;type, const&nbsp;TQString&nbsp;&amp;&nbsp;valueDefault, const&nbsp;TQString&nbsp;&amp;&nbsp;value ) = 0</li>
<li class=fn>virtual bool <a href="#internalEntityDecl"><b>internalEntityDecl</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;name, const&nbsp;TQString&nbsp;&amp;&nbsp;value ) = 0</li>
<li class=fn>virtual bool <a href="#externalEntityDecl"><b>externalEntityDecl</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;name, const&nbsp;TQString&nbsp;&amp;&nbsp;publicId, const&nbsp;TQString&nbsp;&amp;&nbsp;systemId ) = 0</li>
<li class=fn>virtual TQString <a href="#errorString"><b>errorString</b></a> () = 0</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The TQXmlDeclHandler class provides an interface to report declaration
content of XML data.
<p>
<p> You can set the declaration handler with
<a href="tqxmlreader.html#setDeclHandler">TQXmlReader::setDeclHandler</a>().
<p> This interface is based on the SAX2 extension DeclHandler.
<p> The interface provides <a href="#attributeDecl">attributeDecl</a>(), <a href="#internalEntityDecl">internalEntityDecl</a>() and
<a href="#externalEntityDecl">externalEntityDecl</a>() functions.
<p> See also the <a href="xml.html#sax2Intro">Introduction to SAX2</a>.
<p> <p>See also <a href="tqxmldtdhandler.html">TQXmlDTDHandler</a>, <a href="tqxmlcontenthandler.html">TQXmlContentHandler</a>, <a href="tqxmlentityresolver.html">TQXmlEntityResolver</a>, <a href="tqxmlerrorhandler.html">TQXmlErrorHandler</a>, <a href="tqxmllexicalhandler.html">TQXmlLexicalHandler</a>, and <a href="xml-tools.html">XML</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn>bool <a name="attributeDecl"></a>TQXmlDeclHandler::attributeDecl ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;eName, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;aName, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;type, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;valueDefault, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;value )<tt> [pure virtual]</tt>
</h3>
<p> The reader calls this function to report an attribute type
declaration. Only the effective (first) declaration for an
attribute is reported.
<p> The reader passes the name of the associated element in <em>eName</em>
and the name of the attribute in <em>aName</em>. It passes a string that
represents the attribute type in <em>type</em> and a string that
represents the attribute default in <em>valueDefault</em>. This string
is one of "#IMPLIED", "#REQUIRED", "#FIXED" or <a href="tqstring.html#TQString-null">TQString::null</a> (if
none of the others applies). The reader passes the attribute's
default value in <em>value</em>. If no default value is specified in the
XML file, <em>value</em> is TQString::null.
<p> If this function returns FALSE the reader stops parsing and
reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
get the error message.
<h3 class=fn><a href="tqstring.html">TQString</a> <a name="errorString"></a>TQXmlDeclHandler::errorString ()<tt> [pure virtual]</tt>
</h3>
<p> The reader calls this function to get an error string if any of
the handler functions returns FALSE.
<h3 class=fn>bool <a name="externalEntityDecl"></a>TQXmlDeclHandler::externalEntityDecl ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;name, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;publicId, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;systemId )<tt> [pure virtual]</tt>
</h3>
<p> The reader calls this function to report a parsed external entity
declaration. Only the effective (first) declaration for each
entity is reported.
<p> The reader passes the name of the entity in <em>name</em>, the public
identifier in <em>publicId</em> and the system identifier in <em>systemId</em>. If there is no public identifier specified, it passes
<a href="tqstring.html#TQString-null">TQString::null</a> in <em>publicId</em>.
<p> If this function returns FALSE the reader stops parsing and
reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
get the error message.
<h3 class=fn>bool <a name="internalEntityDecl"></a>TQXmlDeclHandler::internalEntityDecl ( const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;name, const&nbsp;<a href="tqstring.html">TQString</a>&nbsp;&amp;&nbsp;value )<tt> [pure virtual]</tt>
</h3>
<p> The reader calls this function to report an internal entity
declaration. Only the effective (first) declaration is reported.
<p> The reader passes the name of the entity in <em>name</em> and the value
of the entity in <em>value</em>.
<p> If this function returns FALSE the reader stops parsing and
reports an error. The reader uses the function <a href="#errorString">errorString</a>() to
get the error message.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>