QXmlStreamWriter Class

メンバ関数のドキュメント

QXmlStreamWriter::QXmlStreamWriter()

ストリームライターを生成します。

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

[explicit] QXmlStreamWriter::QXmlStreamWriter(QByteArray *array)

array へ書き込みを行うストリームライターを生成します。これは、QBuffer デバイス上で動作し、そのデバイスがさらにarray 上で動作する XML ライターを作成することと同じです。

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

device に書き込みを行うストリームライターを構築します。

[explicit] QXmlStreamWriter::QXmlStreamWriter(QString *string)

string に書き込みを行うストリームライターを構築します。

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

デストラクタ。

bool QXmlStreamWriter::autoFormatting() const

自動書式設定が有効になっている場合は `true ` を返し、そうでない場合は `false` を返します。

関連項目: setAutoFormatting()。

QIODevice *QXmlStreamWriter::device() const

QXmlStreamWriter に関連付けられている現在のデバイスを返します。デバイスが割り当てられていない場合は、nullptr を返します。

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

[since 6.10] QXmlStreamWriter::Error QXmlStreamWriter::error() const

ライターの現在のエラー状態を返します。

エラーが発生していない場合、この関数はQXmlStreamWriter::Error::None を返します。

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

errorString()、raiseError()、およびhasError()も参照してください 。

[since 6.10] QString QXmlStreamWriter::errorString() const

エラーが発生した場合、そのエラーに関連するエラーメッセージを返します。

エラーメッセージは、QXmlStreamWriter によって内部的に設定されるか、raiseError()を通じてユーザーによって指定されます。エラーが発生していない場合、この関数は空文字列を返します。

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

error()、raiseError()、およびhasError()も参照してください 。

bool QXmlStreamWriter::hasError() const

データの書き込み中にエラーが発生した場合、true を返します。

エラーが `Error::IO` の場合、基になる `QIODevice ` へのその後の書き込みは失敗します。それ以外の場合は、形式が不正なデータがドキュメントに書き込まれる可能性があります。

エラーステータスは決してリセットされません。エラーが発生した後に実行される書き込みは、たとえエラー状態が解消されたとしても、無視される可能性があります。

error()、errorString()、およびraiseError()も参照してください 。

[since 6.10] void QXmlStreamWriter::raiseError(QAnyStringView message)

指定されたmessage を使用して、カスタムエラーを発生させます。

この関数は、アプリケーションレベルの検証失敗など、書き込み中にエラーが発生したことを手動で示すためのものです。

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

errorString()、error()、およびhasError()も参照してください 。

void QXmlStreamWriter::setAutoFormatting(bool enable)

enable がtrue の場合、自動書式設定を有効にし、そうでない場合は無効にします。

デフォルト値は `false` です。

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

void QXmlStreamWriter::setDevice(QIODevice *device)

現在のデバイスをdevice に設定します。ストリームをQByteArray に書き込みたい場合は、QBuffer デバイスを作成することができます。

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

void QXmlStreamWriter::writeAttribute(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView value)

指定されたnamespaceUri を接頭辞として、name およびvalue で属性を書き込みます。名前空間がまだ宣言されていない場合、QXmlStreamWriter はそれに対する名前空間宣言を生成します。

この関数は、コンテンツが書き込まれる前の `writeStartElement()` の実行後、または `writeEmptyElement()` の実行後のみ呼び出すことができます。

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

attribute を書き込みます。

この関数は、コンテンツが書き込まれる前のwriteStartElement()の後、またはwriteEmptyElement()の後にのみ呼び出すことができます。

void QXmlStreamWriter::writeAttribute(QAnyStringView qualifiedName, QAnyStringView value)

qualifiedName およびvalue を使用して属性を書き込みます。

この関数は、コンテンツが書き込まれる前の `writeStartElement()` の実行後、または `writeEmptyElement()` の実行後にのみ呼び出すことができます。

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

属性ベクトル `attributes` を書き込みます。属性内で参照されている名前空間がまだ宣言されていない場合、QXmlStreamWriter はその名前空間の宣言を生成します。

この関数は、コンテンツが書き込まれる前の `writeStartElement()` の実行後、または `writeEmptyElement()` の実行後のみ呼び出すことができます。

writeAttribute() およびwriteNamespace()も参照してください 。

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

text をCDATAセクションとして書き込みます。text に禁止されている文字列「]]>」が含まれている場合、それは複数のCDATAセクションに分割されます。

この関数は主に完全性を期すために存在します。通常、writeCharacters() がコンテンツ以外の文字をすべて自動的にエスケープするため、これを使用する必要はありません。

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

text を書き込みます。文字「<」、「&」、「""」は、エンティティ参照「&lt;」、「&amp;」、「&quot;」としてエスケープされます。禁止シーケンス「]]>」を回避するため、「>」も「&gt;」としてエスケープされます。

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

void QXmlStreamWriter::writeComment(QAnyStringView text)

text を XML コメントとして書き込みます。ただし、text には、禁止されているシーケンス-- が含まれてはならず、また- で終わってはなりません。なお、XML では、コメント内で- をエスケープする方法は提供されていないことに注意してください。

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

reader の現在の状態を書き込みます。有効な状態はすべてサポートされています。

この関数の目的は、XMLデータの連鎖処理をサポートすることです。

QXmlStreamReader::tokenType()も参照してください 。

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

DTDセクションを記述します。dtd は、XML 1.0仕様におけるdoctypedeclの生成規則全体を表します。

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

namespaceUri に対するデフォルトの名前空間宣言を記述します。

writeStartElement() またはwriteEmptyElement() が呼び出された場合、この宣言は現在の要素に適用されます。それ以外の場合は、次の子要素に適用されます。

なお、http://www.w3.org/XML/1998/namespace（xmlns にバインド）およびhttp://www.w3.org/2000/xmlns/（xml にバインド）という名前空間は、定義上、デフォルトとして宣言することはできません。

void QXmlStreamWriter::writeEmptyElement(QAnyStringView namespaceUri, QAnyStringView name)

name で始まる空の要素を、指定されたnamespaceUri を接頭辞として付与して書き込みます。名前空間が宣言されていない場合、QXmlStreamWriter はその名前空間の宣言を生成します。その後、writeAttribute() を呼び出すと、この要素に属性が追加されます。

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

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

修飾名qualifiedName を持つ空の要素を作成します。その後、writeAttribute()を呼び出すと、この要素に属性が追加されます。

void QXmlStreamWriter::writeEndDocument()

残りのすべての開いている開始要素を閉じ、改行を書き込みます。

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

void QXmlStreamWriter::writeEndElement()

直前の開始要素を閉じます。

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

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

エンティティ参照name を、"&name;" としてストリームに書き込みます。

void QXmlStreamWriter::writeNamespace(QAnyStringView namespaceUri, QAnyStringView prefix = {})

`prefix` を使用して、namespaceUri に対する名前空間宣言を記述します。prefix が空の場合、QXmlStreamWriter は、文字「n」の後に数字が続く一意のプレフィックスを割り当てます。

writeStartElement() またはwriteEmptyElement() が呼び出された場合、宣言は現在の要素に適用されます。それ以外の場合は、次の子要素に適用されます。

プレフィックスxmlは、http://www.w3.org/XML/1998/namespace に対して事前定義され、予約されていることに注意してください。http://www.w3.org/XML/1998/namespace は、他のいかなるプレフィックスにもバインドすることはできません。 プレフィックスxmlnsおよびその URIhttp://www.w3.org/2000/xmlns/は、名前空間メカニズムそのもののために使用されるため、宣言では完全に使用が禁止されています。

void QXmlStreamWriter::writeProcessingInstruction(QAnyStringView target, QAnyStringView data = {})

target およびdata を使用して XML 処理命令を記述します。ただし、data には「?>」という文字列が含まれていてはなりません。

void QXmlStreamWriter::writeStartDocument(QAnyStringView version)

XMLバージョン番号「version 」で始まるドキュメントを作成します。

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

void QXmlStreamWriter::writeStartDocument(QAnyStringView version, bool standalone)

XMLバージョン番号「version 」と、standalone属性「standalone 」で始まるドキュメントを作成します。

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

void QXmlStreamWriter::writeStartDocument()

XMLバージョン番号「1.0」で始まるドキュメントを書き込みます。

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

void QXmlStreamWriter::writeStartElement(QAnyStringView namespaceUri, QAnyStringView name)

指定されたnamespaceUri をプレフィックスとして、name を持つ開始要素を記述します。名前空間がまだ宣言されていない場合、QXmlStreamWriter はそれに対する名前空間宣言を生成します。その後、writeAttribute()を呼び出すと、この要素に属性が追加されます。

関連項目： writeNamespace()、writeEndElement()、およびwriteEmptyElement()。

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

qualifiedName を使用して開始要素を記述します。その後、writeAttribute() を呼び出すと、この要素に属性が追加されます。

writeEndElement() およびwriteEmptyElement()も参照してください 。

void QXmlStreamWriter::writeTextElement(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView text)

name でテキスト要素を記述し、指定されたnamespaceUri をプレフィックスとして付け、text を適用します。名前空間が宣言されていない場合、QXmlStreamWriter はその名前空間の宣言を生成します。

これは、以下の記述と同等の利便性を高める関数です:

stream.writeStartElement(namespaceUri, name);
stream.writeCharacters(text);
stream.writeEndElement();

void QXmlStreamWriter::writeTextElement(QAnyStringView qualifiedName, QAnyStringView text)

qualifiedName およびtext を使用してテキスト要素を描画します。

これは、以下のコードと同等の利便性を高める関数です:

stream.writeStartElement(qualifiedName);
stream.writeCharacters(text);
stream.writeEndElement();