QXmlSimpleReader(3qt)

NAME
QXmlSimpleReader - Implementation of a simple XML reader (parser)

SYNOPSIS
#include <qxml.h>

Inherits QXmlReader.

  Public Members
QXmlSimpleReader ()
virtual ~QXmlSimpleReader ()
virtual bool parse ( const QXmlInputSource * input, bool incremental )
virtual bool parseContinue ()

DESCRIPTION
The QXmlSimpleReader class provides an implementation of a simple XML reader (parser).

This XML reader is sufficient for simple parsing tasks. The reader:

provides a well-formed parser;

does not parse any external entities;

can do namespace processing.

Documents are parsed with a call to parse().

See the tiny SAX2 parser walkthrough.

See also XML.

MEMBER FUNCTION DOCUMENTATION

QXmlSimpleReader::QXmlSimpleReader ()
Constructs a simple XML reader with the following feature settings:

http://xml.org/sax/features/namespaces TRUE

http://xml.org/sax/features/namespace-prefixes FALSE

http://trolltech.com/xml/features/report-whitespace-only-CharData TRUE

http://trolltech.com/xml/features/report-start-end-entity FALSE

More information about features can be found in the Qt SAX2 overview.

See also setFeature().

QXmlSimpleReader::~QXmlSimpleReader () [virtual]
Destroys the simple XML reader.

bool QXmlSimpleReader::parse ( const QXmlInputSource * input, bool incremental ) [virtual]
Reads an XML document from input and parses it. Returns FALSE if the parsing detects an error; otherwise returns TRUE.

If incremental is TRUE, the parser does not return FALSE when it reaches the end of the input without reaching the end of the XML file. Instead it stores the state of the parser so that parsing can be continued at a later stage when more data is available. You can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source input and the parseContinue() tries to read from that input souce. This means you should not delete the input source input until you've finished your calls to parseContinue(). If you call this function with incremental TRUE whilst an incremental parse is in progress a new parsing session will be started and the previous session lost.

If incremental is FALSE, this function behaves like the normal parse function, i.e. it returns FALSE when the end of input is reached without reaching the end of the XML file and the parsing can't be continued.

See also parseContinue() and QSocket.

bool QXmlSimpleReader::parseContinue () [virtual]
Continues incremental parsing; this function reads the input from the QXmlInputSource that was specified with the last parse() command. To use this function, you must have called parse() with the incremental argument set to TRUE.

Returns FALSE if a parsing error occurs; otherwise returns TRUE.

If the input source returns an empty string for the function QXmlInputSource::data(), then this means that the end of the XML file is reached; this is quite important, especially if you want to use the reader to parse more than one XML file.

The case that the end of the XML file is reached without having finished the parsing is not considered as an error -- you can continue parsing at a later stage by calling this function again when there is more data available to parse.

This function assumes that the end of the XML document is reached if the QXmlInputSource::next() function returns QXmlInputSource::EndOfDocument. If the parser has not finished parsing when it encounters this symbol, it is an error and FALSE is returned.

See also parse() and QXmlInputSource::next().

SEE ALSO
http://doc.trolltech.com/qxmlsimplereader.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qxmlsimplereader.3qt) and the Qt version (3.0.3).