QXmlStreamReader Class

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

成员函数文档

QXmlStreamReader::QXmlStreamReader()

构造流阅读器。

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

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

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

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

[explicit] QXmlStreamReader::QXmlStreamReader(QIODevice *device)

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

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

[explicit] QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

这是一个重载函数。

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

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

[noexcept] QXmlStreamReader::~QXmlStreamReader()

销毁阅读器。

void QXmlStreamReader::addData(QAnyStringView data)

添加更多data 供读者阅读。如果阅读器有device() ，则此函数不起作用。

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

void QXmlStreamReader::addData(const QByteArray &data)

这是一个重载函数。

添加更多data 供读者阅读。如果阅读器有device() ，则该函数不起任何作用。

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

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

添加extraNamespaceDeclaration 。该声明对当前元素的子元素有效，如果在读取任何元素之前调用该函数，则对整个 XML 文档有效。

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

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

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

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

bool QXmlStreamReader::atEnd() const

如果阅读器已读取到 XML 文档的末尾，或出现error() 并中止读取，则返回true 。否则，返回false 。

当 atEnd() 和hasError() 返回 true，而error() 返回PrematureEndOfDocumentError 时，表示 XML 到目前为止已经格式化，但还没有解析出完整的 XML 文档。如果 XML 是从QByteArray 读取的，则可以使用addData() 添加下一块 XML；如果 XML 是从QIODevice 读取的，则可以等待更多数据到来。无论哪种方式，一旦有更多数据可用，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 类被定义为QXmlStreamEntityDeclaration 的QList 。

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()。

[since 6.6] bool QXmlStreamReader::hasStandaloneDeclaration() const

如果该文档有明确的独立声明，则返回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 类被定义为QXmlStreamNamespaceDeclaration 的QList 。

另请参见 addExtraNamespaceDeclaration() 和addExtraNamespaceDeclarations()。

QStringView QXmlStreamReader::namespaceUri() const

返回StartElement 或EndElement 的命名空间 Uri。

另请参阅 name() 和qualifiedName()。

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

如果tokenType() 是DTD ，该函数将返回 DTD 的符号声明。否则将返回一个空向量。

QXmlStreamNotationDeclarations 类被定义为QXmlStreamNotationDeclaration 的QList 。

QStringView QXmlStreamReader::prefix() const

返回StartElement 或EndElement 的前缀。

另请参阅 name() 和qualifiedName()。

QStringView QXmlStreamReader::processingInstructionData() const

返回ProcessingInstruction 的数据。

QStringView QXmlStreamReader::processingInstructionTarget() const

返回ProcessingInstruction 的目标值。

QStringView QXmlStreamReader::qualifiedName() const

返回StartElement 或EndElement 的限定名称；

限定名称是 XML 数据中元素的原始名称。它由命名空间前缀、冒号和元素的本地名称组成。由于命名空间前缀不是唯一的（相同的前缀可以指向不同的命名空间，不同的前缀也可以指向相同的命名空间），因此不应使用 qualifiedName()，而应使用解析后的namespaceUri() 和属性的本地name()。

另请参阅 name()、prefix() 和namespaceUri()。

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

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

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

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

在读取StartElement 时调用的便利函数。读取直到相应的EndElement ，并返回两者之间的所有文本。在不出错的情况下，调用该函数后的当前标记（见tokenType()) 为EndElement 。

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

behaviour 定义了在读取到EndElement 之前读取到其他内容时的情况。该函数可以包含子元素的文本（例如对 HTML 很有用），忽略子元素，或引发UnexpectedElementError 并返回到目前为止已读取的内容（默认）。

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

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

但有一个例外，即一旦 readNext() 报告了error() 之后，就无法继续读取 XML 流。然后，atEnd() 返回true ，hasError() 返回true ，本函数返回QXmlStreamReader::Invalid 。

例外情况是error() 返回PrematureEndOfDocumentError 。当到达一个格式良好的 XML 块的末尾，但该块并不代表一个完整的 XML 文档时，就会报告该错误。在这种情况下，当数据流从QByteArray 读取时，可以调用addData() 添加下一个 XML 块，或者当数据流从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()。