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が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 クラスは、QXmlStreamEntityDeclaration のQList として定義されています。

int QXmlStreamReader::entityExpansionLimit() const

1つのエンティティが展開できる最大文字数を返します。1つのエンティティが指定された制限を超えて展開された場合、そのドキュメントはウェルフォームとみなされません。

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 を返します（'yes'または'no'のいずれか）。そうでない場合は、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 の namespaceUri を返します。

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

次のトークンを読み取り、その型を返します。

1つの例外を除き、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 ブックマークの例」では、この関数が多用されています。

readNext()も参照してください 。

[since 6.10] QString QXmlStreamReader::readRawInnerData()

現在の要素の生の内部XMLコンテンツを読み取り、返します。この関数は、ネストされたタグ、テキスト、コメント、処理命令、CDATAセクション、その他のマークアップを含め、要素内に埋め込まれた完全なコンテンツを、元のXML構造を保持したまま取得するのに役立ちます。

現在の要素とは、直近で解析された開始要素に一致し、かつ対応する終了要素にまだ到達していない要素のことです。パーサーが終了要素に到達すると、現在の要素は親要素になります。

この関数は Qt 6.10 で導入されました。

void QXmlStreamReader::setDevice(QIODevice *device)

現在のデバイスをdevice に設定します。デバイスを設定すると、ストリームは初期状態にリセットされます。

device() およびclear()も参照してください 。

void QXmlStreamReader::setEntityExpansionLimit(int limit)

1つのエンティティが展開できる最大文字数をlimit に設定します。1つのエンティティが指定された制限を超えて展開された場合、そのドキュメントはウェルフォームとみなされません。

この制限は、未知のXMLドキュメントを読み込む際に、再帰的なエンティティ展開によって利用可能なメモリがすべて消費されてしまう可能性があり、DoS攻撃を防ぐために設けられています。

このプロパティのデフォルト値は 4096 文字です。

組み込みの XML エンティティ (< など) をサポートするため、最小値は 1 です。

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()も参照してください 。