QDomHandler Class Reference

Inheritance diagram for QDomHandler:

Public Functions
bool	characters (const QString &ch)
	The reader calls this function when it has parsed a chunk of character data (either normal character data or character data inside a CDATA section; if you need to distinguish between those two types you must use QXmlLexicalHandler::startCDATA() and QXmlLexicalHandler::endCDATA()). More...
bool	comment (const QString &ch)
	The reader calls this function to report an XML comment anywhere in the document. More...
bool	endCDATA ()
	The reader calls this function to report the end of a CDATA section. More...
bool	endDocument ()
	The reader calls this function after it has finished parsing. More...
bool	endElement (const QString &nsURI, const QString &localName, const QString &qName)
	The reader calls this function when it has parsed an end element tag with the qualified name qName, the local name localName and the namespace URI namespaceURI. More...
bool	endEntity (const QString &)
	The reader calls this function to report the end of an entity called name. More...
bool	externalEntityDecl (const QString &name, const QString &publicId, const QString &systemId)
	The reader calls this function to report a parsed external entity declaration. More...
bool	fatalError (const QXmlParseException &exception)
	A reader must use this function to report a non-recoverable error. More...
bool	notationDecl (const QString &name, const QString &publicId, const QString &systemId)
	The reader calls this function when it has parsed a notation declaration. More...
bool	processingInstruction (const QString &target, const QString &data)
	The reader calls this function when it has parsed a processing instruction. More...
	QDomHandler (QDomDocumentPrivate *d, bool namespaceProcessing)
void	setDocumentLocator (QXmlLocator *locator)
	The reader calls this function before it starts parsing the document. More...
bool	skippedEntity (const QString &name)
	Some readers may skip entities if they have not seen the declarations (e. More...
bool	startCDATA ()
	The reader calls this function to report the start of a CDATA section. More...
bool	startDTD (const QString &name, const QString &publicId, const QString &systemId)
	The reader calls this function to report the start of a DTD declaration, if any. More...
bool	startElement (const QString &nsURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
	The reader calls this function when it has parsed a start element tag. More...
bool	startEntity (const QString &)
	The reader calls this function to report the start of an entity called name. More...
bool	unparsedEntityDecl (const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
	The reader calls this function when it finds an unparsed entity declaration. More...
	~QDomHandler ()
Public Functions inherited from QXmlDefaultHandler
bool	attributeDecl (const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)
	This reimplementation does nothing. More...
bool	characters (const QString &ch)
	This reimplementation does nothing. More...
bool	comment (const QString &ch)
	This reimplementation does nothing. More...
bool	endCDATA ()
	This reimplementation does nothing. More...
bool	endDocument ()
	This reimplementation does nothing. More...
bool	endDTD ()
	This reimplementation does nothing. More...
bool	endElement (const QString &namespaceURI, const QString &localName, const QString &qName)
	This reimplementation does nothing. More...
bool	endEntity (const QString &name)
	This reimplementation does nothing. More...
bool	endPrefixMapping (const QString &prefix)
	This reimplementation does nothing. More...
bool	error (const QXmlParseException &exception)
	This reimplementation does nothing. More...
QString	errorString () const
	Returns the default error string. More...
bool	externalEntityDecl (const QString &name, const QString &publicId, const QString &systemId)
	This reimplementation does nothing. More...
bool	fatalError (const QXmlParseException &exception)
	This reimplementation does nothing. More...
bool	ignorableWhitespace (const QString &ch)
	This reimplementation does nothing. More...
bool	internalEntityDecl (const QString &name, const QString &value)
	This reimplementation does nothing. More...
bool	notationDecl (const QString &name, const QString &publicId, const QString &systemId)
	This reimplementation does nothing. More...
bool	processingInstruction (const QString &target, const QString &data)
	This reimplementation does nothing. More...
	QXmlDefaultHandler ()
	Constructs a handler for use with subclasses of QXmlReader. More...
bool	resolveEntity (const QString &publicId, const QString &systemId, QXmlInputSource *&ret)
	Sets ret to 0, so that the reader uses the system identifier provided in the XML document. More...
void	setDocumentLocator (QXmlLocator *locator)
	This reimplementation does nothing. More...
bool	skippedEntity (const QString &name)
	This reimplementation does nothing. More...
bool	startCDATA ()
	This reimplementation does nothing. More...
bool	startDocument ()
	This reimplementation does nothing. More...
bool	startDTD (const QString &name, const QString &publicId, const QString &systemId)
	This reimplementation does nothing. More...
bool	startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
	This reimplementation does nothing. More...
bool	startEntity (const QString &name)
	This reimplementation does nothing. More...
bool	startPrefixMapping (const QString &prefix, const QString &uri)
	This reimplementation does nothing. More...
bool	unparsedEntityDecl (const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
	This reimplementation does nothing. More...
bool	warning (const QXmlParseException &exception)
	This reimplementation does nothing. More...
virtual	~QXmlDefaultHandler ()
	Destroys the handler. More...
Public Functions inherited from QXmlContentHandler
virtual	~QXmlContentHandler ()
	Destroys the content handler. More...
Public Functions inherited from QXmlErrorHandler
virtual	~QXmlErrorHandler ()
	Destroys the error handler. More...
Public Functions inherited from QXmlDTDHandler
virtual	~QXmlDTDHandler ()
	Destroys the DTD handler. More...
Public Functions inherited from QXmlEntityResolver
virtual	~QXmlEntityResolver ()
	Destroys the entity resolver. More...
Public Functions inherited from QXmlLexicalHandler
virtual	~QXmlLexicalHandler ()
	Destroys the lexical handler. More...
Public Functions inherited from QXmlDeclHandler
virtual	~QXmlDeclHandler ()
	Destroys the declaration handler. More...

Public Variables
int	errorColumn
int	errorLine
QString	errorMsg

Properties
bool	cdata
QDomDocumentPrivate *	doc
QString	entityName
QXmlLocator *	locator
QDomNodePrivate *	node
bool	nsProcessing

Detailed Description

Definition at line 583 of file qdom.cpp.

Constructors and Destructors

QDomHandler()

QDomHandler::QDomHandler	(	QDomDocumentPrivate *	d,
		bool	namespaceProcessing
	)

Definition at line 7559 of file qdom.cpp.

    : errorLine(0), errorColumn(0), doc(adoc), node(adoc), cdata(false),
        nsProcessing(namespaceProcessing), locator(0)
{
}

~QDomHandler()

QDomHandler::~QDomHandler

(

)

Definition at line 7565 of file qdom.cpp.

{
}

Functions

characters()

bool QDomHandler::characters ( const QString &  ch )

virtual

The reader calls this function when it has parsed a chunk of character data (either normal character data or character data inside a CDATA section; if you need to distinguish between those two types you must use QXmlLexicalHandler::startCDATA() and QXmlLexicalHandler::endCDATA()).

The character data is reported in ch.

Some readers report whitespace in element content using the ignorableWhitespace() function rather than using this one.

A reader may report the character data of an element in more than one chunk; e.g. a reader might want to report "a\<b" in three characters() events ("a ", "\<" and " b").

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlContentHandler.

Definition at line 7625 of file qdom.cpp.

{
    // No text as child of some document
    if (node == doc)
        return false;

    QScopedPointer<QDomNodePrivate> n;
    if (cdata) {
        n.reset(doc->createCDATASection(ch));
    } else if (!entityName.isEmpty()) {
        QScopedPointer<QDomEntityPrivate> e(new QDomEntityPrivate(doc, 0, entityName,
                QString(), QString(), QString()));
        e->value = ch;
        e->ref.deref();
        doc->doctype()->appendChild(e.data());
        e.take();
        n.reset(doc->createEntityReference(entityName));
    } else {
        n.reset(doc->createTextNode(ch));
    }
    n->setLocation(locator->lineNumber(), locator->columnNumber());
    node->appendChild(n.data());
    n.take();

    return true;
}

comment()

bool QDomHandler::comment ( const QString &  ch )

virtual

The reader calls this function to report an XML comment anywhere in the document.

It reports the text of the comment in ch.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlLexicalHandler.

Definition at line 7710 of file qdom.cpp.

{
    QDomNodePrivate *n;
    n = doc->createComment(ch);
    n->setLocation(locator->lineNumber(), locator->columnNumber());
    node->appendChild(n);
    return true;
}

endCDATA()

bool QDomHandler::endCDATA ( )

virtual

The reader calls this function to report the end of a CDATA section.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startCDATA(), QXmlContentHandler::characters()

Implements QXmlLexicalHandler.

Definition at line 7692 of file qdom.cpp.

{
    cdata = false;
    return true;
}

endDocument()

bool QDomHandler::endDocument ( )

virtual

The reader calls this function after it has finished parsing.

It is called just once, and is the last handler function called. It is called after the reader has read all input or has abandoned parsing because of a fatal error.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startDocument()

Implements QXmlContentHandler.

Definition at line 7569 of file qdom.cpp.

{
    // ### is this really necessary? (rms)
    if (node != doc)
        return false;
    return true;
}

endElement()

bool QDomHandler::endElement ( const QString &  namespaceURI, const QString &  localName, const QString &  qName  )

virtual

The reader calls this function when it has parsed an end element tag with the qualified name qName, the local name localName and the namespace URI namespaceURI.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startElement(), {Namespace Support via Features}

Implements QXmlContentHandler.

Definition at line 7616 of file qdom.cpp.

{
    if (!node || node == doc)
        return false;
    node = node->parent();

    return true;
}

endEntity()

bool QDomHandler::endEntity ( const QString &  name )

virtual

The reader calls this function to report the end of an entity called name.

For every startEntity() call, there is a corresponding endEntity() call. The calls to startEntity() and endEntity() are properly nested.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

startEntity(), QXmlContentHandler::skippedEntity(), QXmlSimpleReader::setFeature()

Implements QXmlLexicalHandler.

Definition at line 7704 of file qdom.cpp.

{
    entityName.clear();
    return true;
}

externalEntityDecl()

bool QDomHandler::externalEntityDecl ( const QString &  name, const QString &  publicId, const QString &  systemId  )

virtual

The reader calls this function to report a parsed external entity declaration.

Only the effective (first) declaration for each entity is reported.

The reader passes the name of the entity in name, the public identifier in publicId and the system identifier in systemId. If there is no public identifier specified, it passes an empty string in publicId.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlDeclHandler.

Definition at line 7729 of file qdom.cpp.

{
    return unparsedEntityDecl(name, publicId, systemId, QString());
}

fatalError()

bool QDomHandler::fatalError ( const QXmlParseException &  exception )

virtual

A reader must use this function to report a non-recoverable error.

Details of the error are stored in exception.

If this function returns true the reader might try to go on parsing and reporting further errors, but no regular parsing events are reported.

Implements QXmlErrorHandler.

Definition at line 7678 of file qdom.cpp.

{
    errorMsg = exception.message();
    errorLine =  exception.lineNumber();
    errorColumn =  exception.columnNumber();
    return QXmlDefaultHandler::fatalError(exception);
}

notationDecl()

bool QDomHandler::notationDecl ( const QString &  name, const QString &  publicId, const QString &  systemId  )

virtual

The reader calls this function when it has parsed a notation declaration.

The argument name is the notation name, publicId is the notation's public identifier and systemId is the notation's system identifier.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlDTDHandler.

Definition at line 7734 of file qdom.cpp.

{
    QDomNotationPrivate* n = new QDomNotationPrivate(doc, 0, name, publicId, systemId);
    // keep the refcount balanced: appendChild() does a ref anyway.
    n->ref.deref();
    doc->doctype()->appendChild(n);
    return true;
}

processingInstruction()

bool QDomHandler::processingInstruction ( const QString &  target, const QString &  data  )

virtual

The reader calls this function when it has parsed a processing instruction.

target is the target name of the processing instruction and data is the data in the processing instruction.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlContentHandler.

Definition at line 7652 of file qdom.cpp.

{
    QDomNodePrivate *n;
    n = doc->createProcessingInstruction(target, data);
    if (n) {
        n->setLocation(locator->lineNumber(), locator->columnNumber());
        node->appendChild(n);
        return true;
    }
    else
        return false;
}

setDocumentLocator()

void QDomHandler::setDocumentLocator ( QXmlLocator *  locator )

virtual

The reader calls this function before it starts parsing the document.

The argument locator is a pointer to a QXmlLocator which allows the application to get the parsing position within the document.

Do not destroy the locator; it is destroyed when the reader is destroyed. (Do not use the locator after the reader is destroyed).

Implements QXmlContentHandler.

Definition at line 7743 of file qdom.cpp.

{
    this->locator = locator;
}

skippedEntity()

bool QDomHandler::skippedEntity ( const QString &  name )

virtual

Some readers may skip entities if they have not seen the declarations (e.

g. because they are in an external DTD). If they do so they report that they skipped the entity called name by calling this function.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlContentHandler.

Definition at line 7666 of file qdom.cpp.

{
    // we can only handle inserting entity references into content
    if (!qt_xml_skipped_entity_in_content)
        return true;

    QDomNodePrivate *n = doc->createEntityReference(name);
    n->setLocation(locator->lineNumber(), locator->columnNumber());
    node->appendChild(n);
    return true;
}

startCDATA()

bool QDomHandler::startCDATA ( )

virtual

The reader calls this function to report the start of a CDATA section.

The content of the CDATA section is reported through the QXmlContentHandler::characters() function. This function is intended only to report the boundary.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endCDATA()

Implements QXmlLexicalHandler.

Definition at line 7686 of file qdom.cpp.

{
    cdata = true;
    return true;
}

startDTD()

bool QDomHandler::startDTD ( const QString &  name, const QString &  publicId, const QString &  systemId  )

virtual

The reader calls this function to report the start of a DTD declaration, if any.

It reports the name of the document type in name, the public identifier in publicId and the system identifier in systemId.

If the public identifier is missing, publicId is set to an empty string. If the system identifier is missing, systemId is set to an empty string. Note that it is not valid XML to have a public identifier but no system identifier; in such cases a parse error will occur.

All declarations reported through QXmlDTDHandler or QXmlDeclHandler appear between the startDTD() and endDTD() calls.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endDTD()

Implements QXmlLexicalHandler.

Definition at line 7577 of file qdom.cpp.

{
    doc->doctype()->name = name;
    doc->doctype()->publicId = publicId;
    doc->doctype()->systemId = systemId;
    return true;
}

startElement()

bool QDomHandler::startElement ( const QString &  namespaceURI, const QString &  localName, const QString &  qName, const QXmlAttributes &  atts  )

virtual

The reader calls this function when it has parsed a start element tag.

There is a corresponding endElement() call when the corresponding end element tag is read. The startElement() and endElement() calls are always nested correctly. Empty element tags (e.g. <x>) cause a startElement() call to be immediately followed by an endElement() call.

The attribute list provided only contains attributes with explicit values. The attribute list contains attributes used for namespace declaration (i.e. attributes starting with xmlns) only if the namespace-prefix property of the reader is true.

The argument namespaceURI is the namespace URI, or an empty string if the element has no namespace URI or if no namespace processing is done. localName is the local name (without prefix), or an empty string if no namespace processing is done, qName is the qualified name (with prefix) and atts are the attributes attached to the element. If there are no attributes, atts is an empty attributes object.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endElement(), {Namespace Support via Features}

Implements QXmlContentHandler.

Definition at line 7585 of file qdom.cpp.

{
    // tag name
    QDomNodePrivate* n;
    if (nsProcessing) {
        n = doc->createElementNS(nsURI, qName);
    } else {
        n = doc->createElement(qName);
    }

    if (!n)
        return false;

    n->setLocation(locator->lineNumber(), locator->columnNumber());

    node->appendChild(n);
    node = n;

    // attributes
    for (int i=0; i<atts.length(); i++)
    {
        if (nsProcessing) {
            ((QDomElementPrivate*)node)->setAttributeNS(atts.uri(i), atts.qName(i), atts.value(i));
        } else {
            ((QDomElementPrivate*)node)->setAttribute(atts.qName(i), atts.value(i));
        }
    }

    return true;
}

startEntity()

bool QDomHandler::startEntity ( const QString &  name )

virtual

The reader calls this function to report the start of an entity called name.

Note that if the entity is unknown, the reader reports it through QXmlContentHandler::skippedEntity() and not through this function.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

See also

endEntity(), QXmlSimpleReader::setFeature()

Implements QXmlLexicalHandler.

Definition at line 7698 of file qdom.cpp.

{
    entityName = name;
    return true;
}

unparsedEntityDecl()

bool QDomHandler::unparsedEntityDecl ( const QString &  name, const QString &  publicId, const QString &  systemId, const QString &  notationName  )

virtual

The reader calls this function when it finds an unparsed entity declaration.

The argument name is the unparsed entity's name, publicId is the entity's public identifier, systemId is the entity's system identifier and notationName is the name of the associated notation.

If this function returns false the reader stops parsing and reports an error. The reader uses the function errorString() to get the error message.

Implements QXmlDTDHandler.

Definition at line 7719 of file qdom.cpp.

Referenced by externalEntityDecl().

{
    QDomEntityPrivate* e = new QDomEntityPrivate(doc, 0, name,
            publicId, systemId, notationName);
    // keep the refcount balanced: appendChild() does a ref anyway.
    e->ref.deref();
    doc->doctype()->appendChild(e);
    return true;
}

Properties

cdata

bool QDomHandler::cdata

private

Definition at line 625 of file qdom.cpp.

Referenced by characters(), endCDATA(), and startCDATA().

doc

QDomDocumentPrivate* QDomHandler::doc

private

Definition at line 622 of file qdom.cpp.

Referenced by characters(), comment(), endDocument(), endElement(), notationDecl(), processingInstruction(), skippedEntity(), startDTD(), startElement(), and unparsedEntityDecl().

entityName

QString QDomHandler::entityName

private

Definition at line 624 of file qdom.cpp.

Referenced by characters(), endEntity(), and startEntity().

errorColumn

int QDomHandler::errorColumn

Definition at line 619 of file qdom.cpp.

Referenced by fatalError(), and QDomDocumentPrivate::setContent().

errorLine

int QDomHandler::errorLine

Definition at line 618 of file qdom.cpp.

Referenced by fatalError(), and QDomDocumentPrivate::setContent().

errorMsg

QString QDomHandler::errorMsg

Definition at line 617 of file qdom.cpp.

Referenced by fatalError(), and QDomDocumentPrivate::setContent().

locator

QXmlLocator* QDomHandler::locator

private

Definition at line 627 of file qdom.cpp.

Referenced by characters(), comment(), processingInstruction(), setDocumentLocator(), skippedEntity(), and startElement().

node

QDomNodePrivate* QDomHandler::node

private

Definition at line 623 of file qdom.cpp.

Referenced by characters(), comment(), endDocument(), endElement(), processingInstruction(), skippedEntity(), and startElement().

nsProcessing

bool QDomHandler::nsProcessing

private

Definition at line 626 of file qdom.cpp.

Referenced by startElement().

---

The documentation for this class was generated from the following file:

• /src/xml/dom/qdom.cpp