QTextListFormat::numberPrefix()で番号の前に文字列を挿入

Qt GUIにおけるQTextListFormat::numberPrefix()解説

QTextListFormat::numberPrefix()は、Qt GUIで箇条書きリストの番号の前に表示される文字列を設定するための関数です。

機能

この関数を使うと、デフォルトの番号ではなく、独自の文字列を番号の前に挿入することができます。例えば、以下のような設定が可能です。

• 数字ではなく、アルファベットや記号を番号として使用したい場合
• 番号の前にかっこやスペースを追加したい場合
• 特定の条件に基づいて、番号の前に異なる文字列を表示したい場合

使い方

QTextListFormat::numberPrefix()関数は、以下の形式で使用します。

QTextListFormat listFormat;
listFormat.setNumberPrefix("**"); // 番号の前に**を表示

コード例

以下のコード例は、QTextListFormat::numberPrefix()関数を使用して、箇条書きリストの番号の前に**と)を表示する例です。

QTextDocument document;
QTextCursor cursor = document.textCursor();

// リストフォーマットを作成
QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("**");
listFormat.setNumberSuffix(")");

// リストアイテムを挿入
cursor.insertList(listFormat);
cursor.insertText("項目1");
cursor.insertText("項目2");
cursor.insertText("項目3");

// リストを表示
QTextEdit textEdit;
textEdit.setDocument(&document);
textEdit.show();

実行結果

1)** 項目1
2)** 項目2
3)** 項目3

注意点

• QTextListFormat::numberPrefix()関数は、Qt 4.8以降で導入されました。
• 番号の前に挿入する文字列は、QString型で指定する必要があります。

• QTextListFormat::numberPrefix()関数と合わせて、QTextListFormat::numberSuffix()関数を使用して、番号の後に表示される文字列を設定することもできます。
• QTextListFormatクラスには、その他にも様々なプロパティや関数があります。詳細は、Qtドキュメントを参照してください。

QTextListFormat::numberPrefix()を使用したサンプルコード

数字ではなく、アルファベットを番号として使用

QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListLowerAlpha);
listFormat.setNumberPrefix(""); // 番号プレフィックスを空に設定

// リストアイテムを挿入
for (int i = 0; i < 3; ++i) {
  cursor.insertText(QString::number(i + 1) + ". ");
  cursor.insertText("項目" + QString::number(i + 1));
}

// リストを表示
textEdit.show();

実行結果

• a. 項目1
• b. 項目2
• c. 項目3

番号の前にかっこやスペースを追加

QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");

// リストアイテムを挿入
for (int i = 0; i < 3; ++i) {
  cursor.insertList(listFormat);
  cursor.insertText("項目" + QString::number(i + 1));
}

// リストを表示
textEdit.show();

実行結果

• (1) 項目1
• (2) 項目2
• (3) 項目3

特定の条件に基づいて、番号の前に異なる文字列を表示

QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);

// 奇数項目には**、偶数項目には*を表示
for (int i = 0; i < 3; ++i) {
  if (i % 2 == 0) {
    listFormat.setNumberPrefix("*");
  } else {
    listFormat.setNumberPrefix("**");
  }

  cursor.insertList(listFormat);
  cursor.insertText("項目" + QString::number(i + 1));
}

// リストを表示
textEdit.show();

実行結果

• **項目1
• *項目2
• **項目3

画像を番号として使用

QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDisc);

// 画像ファイルパスを設定
QString imagePath = "image.png";

// リストアイテムを挿入
for (int i = 0; i < 3; ++i) {
  QPixmap pixmap(imagePath);
  listFormat.setNumberPrefix(QPixmap(imagePath));

  cursor.insertList(listFormat);
  cursor.insertText("項目" + QString::number(i + 1));
}

// リストを表示
textEdit.show();

実行結果

• [画像] 項目1

番号の色を変更

QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("**");

// 番号の色を赤に設定
QTextCharFormat charFormat;
charFormat.setForeground(Qt::red);
listFormat.setNumberPrefixFormat(charFormat);

// リストアイテムを挿入
for (int i = 0; i < 3; ++i) {
  cursor.insertList(listFormat);
  cursor.insertText("項目" + QString::number(i + 1));
}

// リストを表示
textEdit.show();

実行結果

QTextListFormat::numberPrefix() 以外の方法

QTextCharFormat::setNumber()関数は、特定の文字フォーマットに対して、番号の形式を設定することができます。

QTextCharFormat charFormat;
charFormat.setFont(QFont("Arial", 12)); // フォント設定
charFormat.setNumber(true); // 番号表示を有効化
charFormat.setNumberPrefix("**"); // 番号プレフィックス設定

// リストアイテムを挿入
cursor.insertText("項目1", charFormat);
cursor.insertText("項目2", charFormat);
cursor.insertText("項目3", charFormat);

// リストを表示
textEdit.show();

QTextList::setFormat()関数は、リスト全体に対して、フォーマットを設定することができます。

QTextList list;
list.setStyle(QTextListFormat::ListDecimal);

// 番号プレフィックス設定
QTextListFormat listFormat;
listFormat.setNumberPrefix("**");
list.setFormat(listFormat);

// リストアイテムを挿入
cursor.insertList(list);
cursor.insertText("項目1");
cursor.insertText("項目2");
cursor.insertText("項目3");

// リストを表示
textEdit.show();

カスタムデリゲート

より高度なカスタマイズが必要な場合は、カスタムデリゲートを使用することができます。

class CustomDelegate : public QAbstractItemDelegate
{
public:
  CustomDelegate(QObject* parent = nullptr) : QAbstractItemDelegate(parent) {}

  void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const override
  {
    // 番号を描画
    if (index.column() == 0) {
      painter->drawText(option.rect, Qt::AlignLeft, QString::number(index.row() + 1) + "**");
    } else {
      // 他の列の描画処理
    }
  }
};

// デリゲートを設定
QListView listView;
listView.setItemDelegate(new CustomDelegate);

// リストモデルを設定
QStandardItemModel model;
model.setHorizontalHeaderLabels({ "項目" });
for (int i = 0; i < 3; ++i) {
  model.appendRow({ QString("項目" + QString::number(i + 1)) });
}
listView.setModel(&model);

listView.show();

これらの方法のどれを使用するかは、要件と目的によって異なります。

• 上記の例は基本的な使用方法を示しています。詳細は、Qtドキュメントを参照してください。