Qt: QTextCharFormat::UnderlineStyle で様々な下線を使いこなす

QTextCharFormat::UnderlineStyle は、Qt GUIにおけるテキスト装飾機能の一部であり、テキストに下線を追加するためのスタイルを定義する列挙型です。この機能を用いることで、単なる直線だけでなく、破線、点線、波線など、様々な下線スタイルをテキストに適用することができます。

列挙体のメンバー

QTextCharFormat::UnderlineStyle は以下のメンバーで構成されています。

SpellCheckUnderline: スペルチェックエラーを示すために使用される下線スタイルです。
WaveUnderline: 波線で下線を引きます。
DashDotDotLine: 破線と2つの点線を交互に並べて下線を引きます。
DashDotLine: 破線と点線を交互に並べて下線を引きます。
DotLine: 点線で下線を引きます。
DashUnderline: 破線で下線を引きます。
SingleUnderline: 単一の直線で下線を引きます。これがデフォルトスタイルです。
NoUnderline: テキストに下線を適用しません。

使用方法

QTextCharFormat::UnderlineStyle を使用するには、以下の手順に従います。

QTextCharFormat オブジェクトを作成します。
setUnderlineStyle() メソッドを使用して、QTextCharFormat::UnderlineStyle のメンバーを指定します。
QTextDocument または QTextBlock オブジェクトに QTextCharFormat オブジェクトを適用します。

例

以下のコードは、テキストに波線の下線を適用する方法を示しています。

QTextCharFormat format;
format.setUnderlineStyle(QTextCharFormat::WaveUnderline);

QTextDocument document;
QTextCursor cursor(&document);

cursor.insertText("This text is underlined with a wave.");
cursor.setCharFormat(format);

QTextCharFormat::UnderlineStyle は、リッチテキストエディタやテキストブラウザなどの様々な Qt GUI アプリケーションで使用することができます。
QTextCharFormat::UnderlineStyle は、テキストの色やフォントなどの他のテキスト装飾プロパティと組み合わせて使用することができます。

例 1: 異なるスタイルの組み合わせ

この例では、異なる QTextCharFormat::UnderlineStyle メンバーを組み合わせて、テキストに複数のスタイルの下線を適用する方法を示します。

#include <QApplication>
#include <QTextDocument>
#include <QTextBlock>
#include <QTextCharFormat>

int main(int argc, char *argv[]) {
    QApplication app(argc, argv);

    QTextDocument document;
    QTextBlock block = document.firstBlock();

    // "This" に波線の下線
    QTextCharFormat waveFormat;
    waveFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
    block.insertText("This", waveFormat);

    // "is" に破線の下線
    QTextCharFormat dashFormat;
    dashFormat.setUnderlineStyle(QTextCharFormat::DashUnderline);
    block.insertText("is", dashFormat);

    // "underlined" に点線の下線
    QTextCharFormat dotFormat;
    dotFormat.setUnderlineStyle(QTextCharFormat::DotLine);
    block.insertText("underlined", dotFormat);

    // "with" にスペルチェックエラーを示す下線
    QTextCharFormat spellFormat;
    spellFormat.setUnderlineStyle(QTextCharFormat::SpellCheckUnderline);
    block.insertText("with", spellFormat);

    // "different" に複数のスタイルを組み合わせた下線
    QTextCharFormat multiFormat;
    multiFormat.setUnderlineStyle(QTextCharFormat::DashDotDotLine);
    block.insertText("different", multiFormat);

    // "styles" に下線なし
    QTextCharFormat noFormat;
    noFormat.setUnderlineStyle(QTextCharFormat::NoUnderline);
    block.insertText("styles", noFormat);

    QTextEdit textEdit;
    textEdit.setDocument(&document);
    textEdit.show();

    return app.exec();
}

この例では、QTextCharFormat::UnderlineStyle を特定の文字列範囲にのみ適用する方法を示します。

#include <QApplication>
#include <QTextDocument>
#include <QTextBlock>
#include <QTextCharFormat>

int main(int argc, char *argv[]) {
    QApplication app(argc, argv);

    QTextDocument document;
    QTextBlock block = document.firstBlock();

    block.insertText("The quick brown fox jumps over the lazy dog.");

    QTextCharFormat underlineFormat;
    underlineFormat.setUnderlineStyle(QTextCharFormat::DashUnderline);

    // "fox" にのみ下線を適用
    block.findText("fox").setCharFormat(underlineFormat);

    QTextEdit textEdit;
    textEdit.setDocument(&document);
    textEdit.show();

    return app.exec();
}

HTML タグを使用する

HTML タグを使用すれば、様々なスタイルの下線をテキストに適用することができます。利点は、HTML タグが広くサポートされていることと、CSS を使ってさらに詳細なスタイル設定が可能であることです。欠点は、Qt GUI 以外の環境でテキストを表示する場合に、レイアウトが崩れる可能性があることです。

<p>This text is underlined with a wave: <span style="text-decoration: wavy;">wavy text</span>.</p>

QPainter を使用する

QPainter を使用すれば、より柔軟な下線スタイルを作成することができます。利点は、線幅、線色、位置などを自由に設定できることです。欠点は、コードが複雑になり、パフォーマンスが低下する可能性があることです。

QPainter painter(&textEdit);

painter.setPen(QPen(Qt::red, 2));
painter.drawText(QRect(10, 20, 100, 30), "This text is underlined with a red line.");

painter.setPen(QPen(Qt::black, 1));
painter.drawLine(QRect(10, 50, 100, 50)); // 下線

カスタム装飾クラスを使用する

カスタム装飾クラスを作成すれば、QTextCharFormat::UnderlineStyle (enum) の機能を拡張することができます。利点は、独自のスタイルを定義したり、既存のスタイルを組み合わせたりできることです。欠点は、開発に時間がかかることと、コードが複雑になる可能性があることです。

サードパーティ製のライブラリを使用する

Qt GUI には、テキスト装飾機能を拡張するサードパーティ製のライブラリがいくつか存在します。利点は、開発時間を短縮できることと、様々な機能を利用できることです。欠点は、ライブラリのライセンス条件を確認する必要があることと、すべての環境で利用できるわけではない可能性があることです。

どの方法を選択すべきか

どの方法を選択すべきかは、状況によって異なります。HTML タグを使用する場合は、シンプルで広くサポートされていますが、レイアウトが崩れる可能性があります。QPainter を使用する場合は、柔軟性がありますが、複雑でパフォーマンスが低下する可能性があります。カスタム装飾クラスを使用する場合は、独自のスタイルを定義できますが、開発に時間がかかります。サードパーティ製のライブラリを使用する場合は、開発時間を短縮できますが、ライセンス条件を確認する必要があります。