QXmlStreamReader 类

  QXmlStreamReader xml;
  ...
  while (!xml.atEnd()) {
        xml.readNext();
        ... // do processing
  }
  if (xml.hasError()) {
        ... // do error handling
  }

成员函数文档

QXmlStreamReader::QXmlStreamReader()

构建流阅读器。

另请参阅setDevice()和addData。

[显式] QXmlStreamReader::QXmlStreamReader(QIODevice *device)

创建一个新的流阅读器，从中读取设备。

另请参阅setDevice()和clear。

[显式] QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

这是一个重载函数。

创建一个新的流阅读器，从中读取数据。

另请参阅addData()、clear和setDevice。

[显式] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

创建一个新的流阅读器，从中读取数据。

另请参阅addData()、clear和setDevice。

[非异常抛出] QXmlStreamReader::~QXmlStreamReader()

销毁阅读器。

void QXmlStreamReader::addData(QAnyStringView data)

为阅读器添加更多数据以供读取。如果阅读器有一个设备，则此函数不做任何事。

另请参阅readNext()和clear。

void QXmlStreamReader::addData(const QByteArray &data)

这是一个重载函数。

为阅读器添加更多数据以供读取。如果阅读器有一个设备，则此函数不做任何事。

另请参阅readNext()和clear。

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

添加一个额外的命名空间声明。该声明对当前元素的子元素有效，或者如果是函数在读取任何元素之前被调用，则对整个XML文档有效。

另请参阅 namespaceDeclarations()、addExtraNamespaceDeclarations() 和 setNamespaceProcessing()。

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

添加由 extraNamespaceDeclarations 指定的声明向量。

另请参阅 namespaceDeclarations() 和 addExtraNamespaceDeclaration()。

bool QXmlStreamReader::atEnd() const

如果读取器已读取到 XML 文档的末尾，或者发生错误并且读取已中止，则返回 true。否则，它返回 false。

当 atEnd() 和 hasError() 返回 true，且 error() 返回 PrematureEndOfDocumentError 时，这意味着 XML 到目前为止已正确形成，但没有完整解析到完整的 XML 文档。如果从 QByteArray 读取 XML，则可以使用 addData() 添加更多的 XML 数据块。如果从 QIODevice 读取 XML，则需要等待更多数据到达。无论如何，在可用更多数据时，atEnd() 會再次返回 false。

另请参阅 hasError()、error()、device() 和 QIODevice::atEnd。

QXmlStreamAttributes QXmlStreamReader::attributes() const

返回 StartElement 的属性。

qint64 QXmlStreamReader::characterOffset() const

返回当前的字符偏移量，从 0 开始。

另请参阅 lineNumber() 和 columnNumber()。

void QXmlStreamReader::clear()

从读取器中删除任何 device() 或数据，并将其内部状态重置到初始状态。

另请参阅 addData()。

qint64 QXmlStreamReader::columnNumber() const

返回当前列号，从 0 开始。

另请参阅 lineNumber() 和 characterOffset()。

QIODevice *QXmlStreamReader::device() const

返回与 QXmlStreamReader 关联的当前设备，如果没有分配设备，则返回 nullptr。

另请参阅 setDevice()。

QStringView QXmlStreamReader::documentEncoding() const

如果tokenType()为StartDocument，则该函数返回XML声明中指定的编码字符串。否则返回空字符串。

QStringView QXmlStreamReader::documentVersion() const

如果tokenType()为StartDocument，则该函数返回XML声明中指定的版本字符串。否则返回空字符串。

QStringView QXmlStreamReader::dtdName() const

如果tokenType()为DTD，则该函数返回DTD的名称。否则返回空字符串。

QStringView QXmlStreamReader::dtdPublicId() const

如果tokenType()为DTD，则该函数返回DTD的公共标识符。否则返回空字符串。

QStringView QXmlStreamReader::dtdSystemId() const

如果tokenType()为DTD，则该函数返回DTD的系统标识符。否则返回空字符串。

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

如果tokenType()为DTD，则该函数返回DTD的未解析（外部）实体声明。否则返回空向量。

QXmlStreamEntityDeclarations类被定义为QList中QXmlStreamEntityDeclaration的集合。

int QXmlStreamReader::entityExpansionLimit() const

返回单个实体允许扩展的最大字符数。如果一个实体扩展超过了给定的限制，则文档被认为不是良好的格式。

另请参阅setEntityExpansionLimit。

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

返回实体解析器，如果没有实体解析器，则返回nullptr。

另请参阅setEntityResolver。

QXmlStreamReader::Error QXmlStreamReader::error() const

返回当前错误的类型，如果没有错误发生，则返回NoError。

另请参阅errorString()和raiseError。

QString QXmlStreamReader::errorString() const

返回通过raiseError设置的错误消息。

另请参阅error、lineNumber、columnNumber和characterOffset。

bool QXmlStreamReader::hasError() const

如果发生错误，则返回 true，否则返回 false。

另请参阅errorString() 和 error()。

[自 6.6 版起] bool QXmlStreamReader::hasStandaloneDeclaration() const

如果此文档有显式的独立声明（可以是 'yes' 或 'no'），则返回 true；否则返回 false；

如果没有解析 XML 声明，此函数返回 false。

该功能自 Qt 6.6 版开始引入。

另请参阅isStandaloneDocument()。

bool QXmlStreamReader::isCDATA() const

如果读取器报告来自 CDATA 部分的字符，则返回 true；否则返回 false。

另请参阅isCharacters() 和 text()。

bool QXmlStreamReader::isCharacters() const

如果 tokenType() 等于 Characters，则返回 true；否则返回 false。

另请参阅isWhitespace() 和 isCDATA()。

bool QXmlStreamReader::isComment() const

如果 tokenType() 等于 Comment，则返回 true；否则返回 false。

bool QXmlStreamReader::isDTD() const

如果 tokenType() 等于 DTD，则返回 true；否则返回 false。

bool QXmlStreamReader::isEndDocument() const

如果 tokenType() 等于 EndDocument，则返回 true；否则返回 false。

bool QXmlStreamReader::isEndElement() const

如果 tokenType() 等于 EndElement，则返回 true；否则返回 false。

bool QXmlStreamReader::isEntityReference() const

如果 tokenType() 等于 EntityReference，则返回 true；否则返回 false。

bool QXmlStreamReader::isProcessingInstruction() const

如果 tokenType() 等于 ProcessingInstruction，则返回 true；否则返回 false。

bool QXmlStreamReader::isStandaloneDocument() const

如果此文档在 XML 声明中已声明为独立，则返回 true；否则返回 false。

如果没有解析 XML 声明，此函数返回 false。

另请参阅hasStandaloneDeclaration。

bool QXmlStreamReader::isStartDocument() const

如果 tokenType() 等于 StartDocument，则返回 true；否则返回 false。

bool QXmlStreamReader>::isStartElement() const

如果 tokenType() 等于 StartElement，则返回 true；否则返回 false。

bool QXmlStreamReader>::isWhitespace() const

如果读取器报告的字符只包含空白字符，则返回 true；否则返回 false。

另请参阅isCharacters() 和 text()。

qint64 QXmlStreamReader>::lineNumber() const

返回当前行号，从1开始。

另请参阅columnNumber() 和 characterOffset。

QStringView QXmlStreamReader>::name() const

返回 StartElement、EndElement 或 EntityReference 的本地名称。

另请参阅namespaceUri() 和 qualifiedName。

QXmlStreamNamespaceDeclarations QXmlStreamReader>::namespaceDeclarations() const

如果 tokenType() 是 StartElement，则此函数返回元素的命名空间声明。否则返回一个空向量。

QXmlStreamNamespaceDeclarations 类定义为一个 QList，其中包含 QXmlStreamNamespaceDeclaration。

另请参阅addExtraNamespaceDeclaration() 和 addExtraNamespaceDeclarations。

QStringView QXmlStreamReader>::namespaceUri() const

返回 StartElement 或 EndElement 的 namespaceUri。

另请参阅name() 和 qualifiedName。

QXmlStreamNotationDeclarations QXmlStreamReader>::notationDeclarations() const

如果 tokenType() 是 DTD，则此函数返回 DTD 的 notation 声明。否则返回一个空向量。

QXmlStreamNotationDeclarations 类定义为一个 QList，其中包含 QXmlStreamNotationDeclaration。

QStringView QXmlStreamReader>::prefix() const

返回 StartElement 或 EndElement 的前缀。

另请参阅name() 和 qualifiedName。

QStringView QXmlStreamReader>::processingInstructionData() const

返回 ProcessingInstruction 的数据。

QStringView QXmlStreamReader::processingInstructionTarget() const

返回处理指令的目标。

QStringView QXmlStreamReader::qualifiedName() const

返回起始元素或结束元素的有效名称。

有效名称是XML数据中元素的原生名称。它由命名空间前缀、冒号以及元素的局部名称组成。由于命名空间前缀不是唯一的（相同的前缀可以指向不同的命名空间，不同的前缀可以指向相同的命名空间），你不应该使用qualifiedName()，而是使用已解析的namespaceUri()以及属性的局部name()。

另请参阅 name()，prefix()以及namespaceUri()。

void QXmlStreamReader::raiseError(const QString &message = QString())

引发带有可选错误消息的自定义错误。

另请参阅 error()和errorString()。

QString QXmlStreamReader::readElementText(QXmlStreamReader::ReadElementTextBehaviour behaviour = ErrorOnUnexpectedElement)

这是一个便利函数，在读取到的元素为起始元素时调用。读取到对应的结束元素并返回两者之间的所有文本。如果没有错误，则调用此函数后的当前标记（见tokenType()）是结束元素。

在读取到Characters或EntityReference标记时，此函数将text()拼接在一起，但会跳过ProcessingInstruction和Comment。如果当前标记不是StartElement，则返回空字符串。

behaviour定义在读取到EndElement之前读取到任何其他内容时会发生什么。函数可以包含子元素的文本（例如，对于HTML很有用），忽略子元素或引发UnexpectedElementError并返回迄今为止读取的内容（默认）。

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

读取下一个标记并返回其类型。

除了一个例外，一旦readNext()报告了错误，就不可能继续读取XML流。然后atEnd()返回true，hasError()返回true，并且此函数返回QXmlStreamReader::Invalid。

异常出现在当error()()返回PrematureEndOfDocumentError时。此错误在遇到一个格式正确但不是完整XML文档的XML片段的末尾时报告。在这种情况下，可以通过调用addData()()来恢复解析，向流中添加下一个XML片段，或者等待更多数据到达，当流来自QByteArray或者从device()读取时。

另请参阅tokenType()和tokenString。

bool QXmlStreamReader::readNextStartElement()

读取直到当前元素内的下一个起始元素。当达到起始元素时返回true。当遇到元素结束或发生错误时返回false。

当前元素是与最近解析的起始元素匹配的元素，但没有达到匹配的结束元素。当解析器达到结束元素时，当前元素变为父元素。

这是一个方便函数，当您只关心解析XML元素时使用。在QXmlStream Bookmarks示例中广泛使用了此函数。

另请参阅readNext。

void QXmlStreamReader::setDevice(QIODevice *device)

设置当前设备为device。设置设备会将流重置为其初始状态。

另请参阅device()和clear()。

void QXmlStreamReader::setEntityExpansionLimit(int limit)

设置单个实体允许扩展的最大字符数为limit。如果一个实体超出给定限制，该文档将不被视为格式正确。

这个限制是为了防止在加载未知XML文档时遭受DoS攻击，因为递归实体扩展可能会导致耗尽所有可用内存。

此属性的默认值是4096个字符。

另请参阅entityExpansionLimit。

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

使resolver成为新的entityResolver。

流读取器不会获取解析器的所有权。确保解析器在整个流读取器对象的生命周期内有效，或者直到设置另一个解析器或nullptr是调用者的责任。

另请参阅entityResolver。

void QXmlStreamReader::skipCurrentElement()

读取直到当前元素的末尾，跳过任何子节点。此函数对于跳过未知元素很有用。

当前元素是与最近解析的起始元素匹配的元素，但没有达到匹配的结束元素。当解析器达到结束元素时，当前元素变为父元素。

QStringView QXmlStreamReader::text() const

返回Characters、Comment、DTD或EntityReference的文本。

QString QXmlStreamReader::tokenString() const

返回当前标记的字符串表示。

参见tokenType。

QXmlStreamReader::TokenType QXmlStreamReader::tokenType() const

返回当前标记的类型。

您还可以使用以下便利函数查询当前标记：isStartDocument()，isEndDocument()，isStartElement()，isEndElement()，isCharacters()，isComment()，isDTD()，isEntityReference()，以及 isProcessingInstruction()。

参见tokenString。