~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QXmlDefaultHandler Class Reference</h1>

<p>The QXmlDefaultHandler class provides a default implementation of all the XML handler classes. <a href="#details">More...</a></p>

<pre>#include <QXmlDefaultHandler></pre><p>Part of the <a href="qtxml.html">QtXml</a> module.</p>

<p>Inherits <a href="qxmlcontenthandler.html">QXmlContentHandler</a>, <a href="qxmlerrorhandler.html">QXmlErrorHandler</a>, <a href="qxmldtdhandler.html">QXmlDTDHandler</a>, <a href="qxmlentityresolver.html">QXmlEntityResolver</a>, <a href="qxmllexicalhandler.html">QXmlLexicalHandler</a>, and <a href="qxmldeclhandler.html">QXmlDeclHandler</a>.</p>

<p><b>Note:</b> All the functions in this class are <a href="threads.html#reentrant">reentrant</a>.</p>

<ul>

<li><a href="qxmldefaulthandler-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qxmldefaulthandler.html#QXmlDefaultHandler">QXmlDefaultHandler</a></b> ()</li>

<li><div class="fn"/>virtual <b><a href="qxmldefaulthandler.html#dtor.QXmlDefaultHandler">~QXmlDefaultHandler</a></b> ()</li>

</ul>

<ul>

<li><div class="fn"/>12 public functions inherited from <a href="qxmlcontenthandler.html#public-functions">QXmlContentHandler</a></li>

<li><div class="fn"/>4 public functions inherited from <a href="qxmlerrorhandler.html#public-functions">QXmlErrorHandler</a></li>

<li><div class="fn"/>3 public functions inherited from <a href="qxmldtdhandler.html#public-functions">QXmlDTDHandler</a></li>

<li><div class="fn"/>2 public functions inherited from <a href="qxmlentityresolver.html#public-functions">QXmlEntityResolver</a></li>

<li><div class="fn"/>8 public functions inherited from <a href="qxmllexicalhandler.html#public-functions">QXmlLexicalHandler</a></li>

<li><div class="fn"/>4 public functions inherited from <a href="qxmldeclhandler.html#public-functions">QXmlDeclHandler</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QXmlDefaultHandler class provides a default implementation of all the XML handler classes.</p>

<p>This class gathers together the features of the specialized handler classes, making it a convenient starting point when implementing custom handlers for subclasses of <a href="qxmlreader.html">QXmlReader</a>, particularly <a href="qxmlsimplereader.html">QXmlSimpleReader</a>. The virtual functions from each of the base classes are reimplemented in this class, providing sensible default behavior for many common cases. By subclassing this class, and overriding these functions, you can concentrate on implementing the parts of the handler relevant to your application.</p>

<p>The XML reader must be told which handler to use for different kinds of events during parsing. This means that, although QXmlDefaultHandler provides default implementations of functions inherited from all its base classes, we can still use specialized handlers for particular kinds of events.</p>

<p>For example, QXmlDefaultHandler subclasses both <a href="qxmlcontenthandler.html">QXmlContentHandler</a> and <a href="qxmlerrorhandler.html">QXmlErrorHandler</a>, so by subclassing it we can use the same handler for both of the following reader functions:</p>

<pre>  xmlReader.setContentHandler(handler);

xmlReader.setErrorHandler(handler);</pre>

<p>Since the reader will inform the handler of parsing errors, it is necessary to reimplement <a href="qxmlerrorhandler.html#fatalError">QXmlErrorHandler::fatalError</a>() if, for example, we want to stop parsing when such an error occurs:</p>

<pre>  bool Handler::fatalError (const QXmlParseException & exception)

{

qWarning() << "Fatal error on line" << exception.lineNumber()

<< ", column" << exception.columnNumber() << ":"

<< exception.message();

return false;

}</pre>

<p>The above function returns false, which tells the reader to stop parsing. To continue to use the same reader, it is necessary to create a new handler instance, and set up the reader to use it in the manner described above.</p>

<p>It is useful to examine some of the functions inherited by QXmlDefaultHandler, and consider why they might be reimplemented in a custom handler. Custom handlers will typically reimplement <a href="qxmlcontenthandler.html#startDocument">QXmlContentHandler::startDocument</a>() to prepare the handler for new content. Document elements and the text within them can be processed by reimplementing <a href="qxmlcontenthandler.html#startElement">QXmlContentHandler::startElement</a>(), <a href="qxmlcontenthandler.html#endElement">QXmlContentHandler::endElement</a>(), and <a href="qxmlcontenthandler.html#characters">QXmlContentHandler::characters</a>(). You may want to reimplement <a href="qxmlcontenthandler.html#endDocument">QXmlContentHandler::endDocument</a>() to perform some finalization or validation on the content once the document has been read completely.</p>

<p>See the qt/examples/xml/rsslisting example for more information on creating a custom handler.</p>

<p>See also the <a href="xml.html#sax2intro">Introduction to SAX2</a>.</p>

<p><a href="qxmlerrorhandler.html">QXmlErrorHandler</a> <a href="qxmllexicalhandler.html">QXmlLexicalHandler</a></p>

<p>See also <a href="qxmldtdhandler.html">QXmlDTDHandler</a>, <a href="qxmldeclhandler.html">QXmlDeclHandler</a>, <a href="qxmlcontenthandler.html">QXmlContentHandler</a>, and <a href="qxmlentityresolver.html">QXmlEntityResolver</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QXmlDefaultHandler"></a>QXmlDefaultHandler::QXmlDefaultHandler ()</h3>

<p>Constructs a handler for use with subclasses of <a href="qxmlreader.html">QXmlReader</a>.</p>

<h3 class="fn"><a name="dtor.QXmlDefaultHandler"></a>QXmlDefaultHandler::~QXmlDefaultHandler ()  <tt> [virtual]</tt></h3>

<p>Destroys the handler.</p>

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

</tr></table></div></address></body>

</html>

Older »