Qt Widgets: QListWidgetItem::setForeground()を使いこなして、個性豊かなリストアイテムをデザインしよう

QListWidgetItem::setForeground() 関数は、Qt Widgets ライブラリにおける QListWidgetItem クラスのメソッドで、リストアイテムの前面色を設定するために使用されます。前面色は、リストアイテム内のテキストやアイコンの色を指します。

この関数は、QBrush オブジェクトを引数として受け取り、そのオブジェクトを使用して前面色を設定します。QBrush オブジェクトは、色だけでなく、パターンやグラデーションなどの属性も設定できます。

構文

void QListWidgetItem::setForeground(const QBrush &brush);

引数

brush: 前面色を設定する QBrush オブジェクト

戻り値

なし

例

// 赤色で前面色を設定
QListWidgetItem *item = new QListWidgetItem("アイテム");
item->setForeground(QBrush(Qt::red));

// カラーパレットから色を選択
QColor color = QColorDialog::getColor(this, "前面色を選択", Qt::black);
item->setForeground(QBrush(color));

// グラデーションで前面色を設定
QLinearGradient gradient(0, 0, 100, 0);
gradient.setColorAt(0, Qt::white);
gradient.setColorAt(1, Qt::blue);
item->setForeground(QBrush(gradient));

グローバルスタイルシートが設定されている場合、QListWidgetItem::setForeground() 関数で設定した前面色は上書きされる可能性があります。
Qt 5.15.2 以降では、スタイルシートを使用してリストアイテムの前面色を設定することもできます。
QListWidgetItem::setForeground() 関数は、Qt 4.2 以降で使用できます。

QListWidget *listWidget = new QListWidget;
listWidget->addItem("アイテム 1");
listWidget->addItem("アイテム 2");
listWidget->addItem("アイテム 3");

// アイテム 2 の前面色を赤色に設定
QListWidgetItem *item2 = listWidget->item(1);
item2->setForeground(QBrush(Qt::red));

例 2: カラーパレットから色を選択して前面色を設定

この例では、カラーパレットを使用して色を選択し、QListWidgetItem の前面色を設定します。

QListWidget *listWidget = new QListWidget;
listWidget->addItem("アイテム 1");
listWidget->addItem("アイテム 2");
listWidget->addItem("アイテム 3");

// カラーパレットを開き、色を選択
QColor color = QColorDialog::getColor(this, "前面色を選択", Qt::black);

// アイテム 3 の前面色を選択した色に設定
QListWidgetItem *item3 = listWidget->item(2);
item3->setForeground(QBrush(color));

例 3: グラデーションで前面色を設定

この例では、グラデーションを使用して QListWidgetItem の前面色を設定します。

QListWidget *listWidget = new QListWidget;
listWidget->addItem("アイテム 1");
listWidget->addItem("アイテム 2");
listWidget->addItem("アイテム 3");

// グラデーションを作成
QLinearGradient gradient(0, 0, 100, 0);
gradient.setColorAt(0, Qt::white);
gradient.setColorAt(1, Qt::blue);

// アイテム 1 の前面色をグラデーションに設定
QListWidgetItem *item1 = listWidget->item(0);
item1->setForeground(QBrush(gradient));

カラーパレットやグラデーションエディタを使用して、色を選択することもできます。
QBrush オブジェクトを使用して、色、パターン、グラデーションなどを設定することができます。
各例では、異なる方法でアイテムの前面色を設定しています。
上記の例では、QListWidget ウィジェットに 3 つのアイテムを作成しています。

代替方法

以下に、QListWidgetItem::setForeground() の代替方法として考えられる方法をいくつか紹介します。

スタイルシートを使用する

Qt 5.15 以降では、スタイルシートを使用してリストアイテムの前面色を設定することができます。スタイルシートを使用すれば、より柔軟に前面色を設定することができ、コードを簡潔に保つことができます。

QListWidgetItem {
  color: red; /* 前面色を赤色に設定 */
}

上記のように、スタイルシートで color プロパティを設定することで、リストアイテムの前面色を設定することができます。

デリゲートを使用する

QListWidgetItem クラスには、setData() メソッドを使用してデータを設定することができます。このデータを活用して、デリゲートを使用して前面色を設定することができます。

class MyDelegate : public QItemDelegate
{
public:
  void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
  {
    // 前面色を設定する処理
    painter->setPen(Qt::red);
    painter->drawText(option.rect(), Qt::AlignCenter, index.data().toString());
  }
};

上記のように、デリゲートクラスを作成し、paint() メソッド内で前面色を設定する処理を記述することで、リストアイテムの前面色を設定することができます。

カスタムウィジェットを使用する

リストアイテムを完全にカスタマイズしたい場合は、QListWidgetItem クラスではなく、カスタムウィジェットを使用することができます。カスタムウィジェットを使用すれば、前面色だけでなく、アイコンやチェック状態など、リストアイテムのあらゆる要素を自由に設定することができます。

class MyItemWidget : public QWidget
{
public:
  MyItemWidget(const QString &text)
  {
    setText(text);
  }

  void paintEvent(QPaintEvent *event) override
  {
    QPainter painter(this);

    // 前面色を設定する処理
    painter.setPen(Qt::red);
    painter.drawText(rect(), Qt::AlignCenter, text());
  }
};

上記のように、カスタムウィジェットクラスを作成し、paintEvent() メソッド内で前面色を設定する処理を記述することで、リストアイテムの前面色を設定することができます。

どの方法を選択すべきか

どの方法を選択すべきかは、状況によって異なります。

リストアイテムを完全にカスタマイズしたい場合は、デリゲートやカスタムウィジェットを使用する必要があります。
より柔軟な前面色設定や、コードの簡潔化が必要であれば、スタイルシートを使用するのがおすすめです。
シンプルな前面色設定であれば、QListWidgetItem::setForeground() 関数を使用するのが最も簡単です。