【保存版】Qt GUIプログラミングでリッチテキストを扱うならこの1冊！QTextDocumentクラス完全ガイド

Qt GUIにおけるQTextDocumentクラスは、構造化されたリッチテキスト文書を扱うための基盤となるクラスです。プレーンテキストだけでなく、書式設定されたテキスト、画像、表、リストなどを含む複雑な文書を表現できます。

主な機能

編集機能
QTextEditなどのエディタと連携し、文書の編集を可能にします。
入出力サポート
リッチテキスト形式、HTML形式、プレーンテキスト形式など、様々な形式で文書を読み書きできます。
柔軟なレイアウト
文書全体のレイアウトを制御し、様々な表示形式に対応できます。
様々な文書要素のサポート
画像、表、リスト、フレームなどの文書要素を埋め込むことができます。
書式設定されたテキストの保持と操作
フォント、色、配置などの書式設定をテキストに適用し、見栄えの良い文書を作成できます。

利点

再利用性
文書を部品として再利用することで、開発効率を向上できます。
柔軟性
様々な文書形式に対応し、様々なレイアウトを構築できます。
リッチな文書表現
プレーンテキストよりも視覚的に訴求力のある文書を作成できます。

例

以下のコード例は、QTextDocumentクラスを使用して、シンプルなリッチテキスト文書を作成する方法を示しています。

#include <QTextDocument>
#include <QTextEdit>

int main() {
  // QTextDocumentオブジェクトを作成
  QTextDocument document;

  // プレーンテキストを追加
  document.setPlainText("Hello, World!");

  // フォントを設定
  QFont font("Arial", 16);
  document.setDefaultFont(font);

  // テキストの色を設定
  QTextCharFormat format;
  format.setTextColor(Qt::red);
  document.setCharFormat(QTextCursor(document).selectionStart(),
                        QTextCursor(document).selectionEnd(),
                        format);

  // QTextEditウィジェットを作成
  QTextEdit textEdit;

  // QTextDocumentをQTextEditに設定
  textEdit.setDocument(&document);

  // ウィジェットを表示
  textEdit.show();

  return 0;
}

このコードを実行すると、"Hello, World!"という赤い文字で表示されるシンプルなテキストエディタウィンドウが表示されます。

QTextDocumentクラスは、Qt GUIにおけるリッチテキスト処理の基盤となる強力なツールです。プレーンテキストよりも視覚的に訴求力のある文書を作成し、様々な文書形式に対応し、様々なレイアウトを構築することができます。

画像の埋め込み

画像を文書に埋め込むには、QTextImageFormatクラスを使用します。以下のコード例は、画像ファイルを文書に追加する方法を示しています。

QTextImageFormat imageFormat;
imageFormat.setSource("image.png");
document.setHtml(QString("<p><img src=\"%1\"></p>").arg(imageFormat.source()));

このコードを実行すると、"image.png"という画像ファイルが文書に埋め込まれます。

表の作成

表を作成するには、QTextTableFormatクラスとQTextTableCellFormatクラスを使用します。以下のコード例は、シンプルな表を作成する方法を示しています。

QTextTableFormat tableFormat;
tableFormat.setColumns(3);

QTextTableCellFormat cellFormat;
cellFormat.setAlignment(Qt::AlignHCenter | Qt::AlignVCenter);

QTextCursor cursor(document);
cursor.insertTable(2, 3, tableFormat);

for (int row = 0; row < 2; ++row) {
  for (int col = 0; col < 3; ++col) {
    cursor.insertText(QString("Cell (%1, %2)").arg(row + 1).arg(col + 1));
    cursor.setTableCellFormat(cellFormat);
    cursor.nextCell();
  }
}

このコードを実行すると、2行3列の表が文書に作成されます。

文書全体のレイアウトの制御

文書全体のレイアウトを制御するには、QTextFrameFormatクラスを使用します。以下のコード例は、文書の余白を設定する方法を示しています。

QTextFrameFormat frameFormat;
frameFormat.setMargin(10);
document.rootFrame()->setFrameFormat(frameFormat);

このコードを実行すると、文書のすべての余白が10ピクセルに設定されます。

文書の入出力

文書を読み書きするには、save()とload()メソッドを使用します。以下のコード例は、文書をHTML形式で保存し、その後読み込む方法を示しています。

document.save("document.html");

QFile file("document.html");
if (file.open(QIODevice::ReadOnly)) {
  QByteArray data = file.readAll();
  document.loadHtml(data);
  file.close();
}

このコードを実行すると、"document.html"というファイルに文書が保存され、その後読み込まれて文書ウィジェットに表示されます。

QTextEditとの連携

QTextDocumentクラスは、QTextEditなどのエディタウィジェットと連携して、文書の編集を可能にします。以下のコード例は、QTextEditウィジェットを使用して文書を編集する方法を示しています。

QTextEdit textEdit;
textEdit.setDocument(&document);

// 編集操作を接続
connect(textEdit, &QTextEdit::textChanged, this, &MyClass::onTextChanged);

void MyClass::onTextChanged() {
  // 文書の内容が変更されたときに処理を行う
}

このコードを実行すると、QTextEditウィジェットに文書が表示され、ユーザーがテキストを編集することができます。textChanged()シグナルは、文書の内容が変更されたときにemitされ、onTextChanged()スロットが呼び出されます。

Qt GUIにおけるQTextDocumentクラスは、構造化されたリッチテキスト文書を扱うための基盤となる強力なツールです。しかし、状況によっては、QTextDocumentクラスよりも適切な代替手段が存在する可能性があります。

代替手段の選択

QTextDocumentクラスの代替手段を選択する際には、以下の要素を考慮する必要があります。

メンテナンス性
将来的にコードを修正したり拡張したりする必要性があるかどうか。
開発の容易さ
コードを書くのが得意かどうか。
パフォーマンス
文書のサイズや複雑さに応じて、パフォーマンスが重要になる場合があります。
必要な機能
どのような機能が必要か。例えば、プレーンテキストのみを扱うのか、リッチテキスト機能が必要か、画像や表などの要素を埋め込む必要があるか。

代替手段の例

以下に、QTextDocumentクラスの代替手段となるいくつかの例を紹介します。

Asynchronous Document Model (QDomDocument)
構造化されたXML文書を扱う必要がある場合は、QDomDocumentクラスを使用することができます。
Rich Text Format (RTF)
リッチテキスト機能が必要で、文書を異なるアプリケーション間で共有する必要がある場合は、RTFを使用することができます。RTFは、QTextStreamクラスを使用して読み書きできます。
HTML
リッチテキスト機能が必要で、パフォーマンスが重要でない場合は、HTMLを使用することができます。HTMLは、QWebViewクラスを使用して表示できます。
プレーンテキスト
リッチテキスト機能が必要ない場合は、単純なプレーンテキストを使用することができます。プレーンテキストは、QPlainTextEditクラスを使用して処理できます。

QDomDocument
XML文書を表現するためのクラスです。構造化された文書を扱う場合に適しています。
QTextStream
テキストファイルの読み書きのためのクラスです。RTF形式を含む様々なテキストフォーマットをサポートしています。
QWebView
HTMLコンテンツを表示するためのウィジェットです。リッチテキスト機能をサポートしており、JavaScriptなどのインタラクティブな機能も利用できます。
QPlainTextEdit
プレーンテキストの編集に特化したエディタウィジェットです。書式設定機能は限られていますが、シンプルでパフォーマンスが速いという利点があります。