QTextDocumentWriter Class
QTextDocumentWriter クラスは、QTextDocument をファイルやその他のデバイスに書き込むための、形式に依存しないインターフェイスを提供します。詳細...
| Header: | #include <QTextDocumentWriter> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
- 継承メンバを含む全メンバ一覧
- QTextDocumentWriter はRich Text Processing API の一部です。
パブリック関数
| QTextDocumentWriter() | |
| QTextDocumentWriter(QIODevice *device, const QByteArray &format) | |
| QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray()) | |
| ~QTextDocumentWriter() | |
| QIODevice * | device() const |
| QString | fileName() const |
| QByteArray | format() const |
| void | setDevice(QIODevice *device) |
| void | setFileName(const QString &fileName) |
| void | setFormat(const QByteArray &format) |
| bool | write(const QTextDocument *document) |
| bool | write(const QTextDocumentFragment &fragment) |
静的パブリックメンバ
| QList<QByteArray> | supportedDocumentFormats() |
詳細説明
ドキュメントを書き込むには、QTextDocumentWriter オブジェクトをファイル名かデバイスオブジェクトで構築し、書き込むドキュメントフォーマットを指定します。ライターを構築し、setFormat() を使用してフォーマットを設定することは後で可能です。
write() をコールして、ドキュメントをデバイスに書き込みます。ドキュメントの書き込みに成功すると、この関数はtrue を返す。ただし、ドキュメントの書き込み時にエラーが発生した場合は false を返します。
QTextDocumentWriter が書き込めるフォーマットの一覧は、supportedDocumentFormats() を呼び出します。
サポートされている出力フォーマットの機能はかなり異なるので、ライターは各フォーマットに適切なオブジェクトのサブセットを単純に出力します。これには通常、文書に含まれる書式付きテキストと画像が含まれます。
メンバ関数 ドキュメント
QTextDocumentWriter::QTextDocumentWriter()
空の QTextDocumentWriter オブジェクトを構築します。書き込む前に、setFormat() を呼び出してドキュメント・フォーマットを設定し、次にsetDevice() またはsetFileName() を呼び出す必要があります。
QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)
QTextDocumentWriter オブジェクトを構築し、format で指定されたドキュメント・フォーマットで、指定されたdevice に書き込みます。
[explicit] QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray())
format で指定されたドキュメント形式を使用して、fileName という名前のファイルに書き込む QTextDocumentWriter オブジェクトを構築します。format が提供されない場合、QTextDocumentWriter はfileName の拡張子を検査することでドキュメント形式を検出します。
[noexcept] QTextDocumentWriter::~QTextDocumentWriter()
QTextDocumentWriter オブジェクトを破棄する。
QIODevice *QTextDocumentWriter::device() const
現在割り当てられているデバイスを返し、デバイスが割り当てられていない場合はnullptr を返します。
setDevice()も参照 。
QString QTextDocumentWriter::fileName() const
現在割り当てられているデバイスがQFile の場合、またはsetFileName() が呼び出された場合、この関数は書き込むファイル名を返す。それ以外の場合は、空の文字列を返す。
setFileName() およびsetDevice()も参照のこと 。
QByteArray QTextDocumentWriter::format() const
ドキュメントの書き込みに使用される書式を返します。
setFormat() も参照 。
void QTextDocumentWriter::setDevice(QIODevice *device)
ライターのデバイスを、指定されたdevice に設定します。すでにデバイスが設定されている場合、古いデバイスは削除されますが、それ以外は変更されません。
デバイスがまだオープンされていない場合、QTextDocumentWriter は、open()を呼び出してWriteOnly モードでデバイスをオープンしようとする。
注意： これは、QProcess 、QTcpSocket 、QUdpSocket など、デバイスを開く前に何らかの設定が必要な特定のデバイスでは機能しない。
device() およびsetFileName()も参照のこと 。
void QTextDocumentWriter::setFileName(const QString &fileName)
fileName に書き込むファイル名を設定する。内部的には、QTextDocumentWriter はQFile を作成し、WriteOnly モードで開き、ドキュメントの書き込み時にこのファイルを使用する。
fileName() およびsetDevice()も参照 。
void QTextDocumentWriter::setFormat(const QByteArray &format)
format format は、大文字小文字を区別しないテキスト文字列です。例えば
QTextDocumentWriter writer; writer.setFormat("odf"); // same as writer.setFormat("ODF");
QTextDocumentWriter がサポートしている書式の一覧は、supportedDocumentFormats() を呼び出すことで確認できます。
format()も参照 。
[static] QList<QByteArray> QTextDocumentWriter::supportedDocumentFormats()
QTextDocumentWriter がサポートしているドキュメント形式のリストを返します。
デフォルトでは、Qt は以下のフォーマットを書くことができます：
| フォーマット | 説明 |
|---|---|
| プレーンテキスト | プレーンテキスト |
| HTML | ハイパーテキストマークアップ言語 |
| マークダウン | マークダウン（CommonMarkまたはGitHub方言） |
| ODF | オープン・ドキュメント・フォーマット |
setFormat()も参照 。
bool QTextDocumentWriter::write(const QTextDocument *document)
指定されたdocument を指定されたデバイスまたはファイルに書き込み、成功した場合はtrue を返し、失敗した場合はfalse を返します。
bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)
fragment false で指定されたドキュメントフラグメントを、割り当てられたデバイスまたはファイルに書き込み、成功した場合は を返します。true
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
