详解QListWidget如何实现自定义Item效果

QListWidget是Qt中非常常见的控件之一，它提供了便捷的列表展示功能，可以很方便的展示一组数据，同时也可以支持自定义Item效果。本文将详细介绍QListWidget如何实现自定义Item效果。

一、QListWidgetItem

QListWidgetItem是QListWidget用于展示每一个Item的基本数据类型。QListWidgetItem具有以下属性：

1. text：显示在Item中的文本；

2. icon：显示在Item中的图标；

3. toolTip：鼠标悬浮时显示的文本；

4. statusTip：状态栏显示的文本；

5. checkState：勾选框状态；

6. foreground：前景色；

7. background：背景色；

8. font：字体。

可以通过以下代码创建一个QListWidgetItem：

[item = new QListWidgetItem(text, listwidget)];

其中text是要显示的文本，listwidget是这个Item所属的QListWidget。可以通过以下代码设置QListWidgetItem的属性：

item->setIcon(icon);      //设置Item的图标
item->setToolTip(toolTip); //设置Item的提示文本
item->setStatusTip(statusTip); //设置Item的状态栏文本
item->setCheckState(Qt::Unchecked); //设置Item的勾选状态
item->setForeground(foreground); //设置Item的前景色
item->setBackground(background); //设置Item的背景色
item->setFont(font); //设置Item的字体

二、自定义Item

要实现自定义Item效果，需要继承QListWidgetItem类，并实现自己的paint()函数。paint()函数用于绘制Item。

以下是一种自定义Item的实现方式：

1. 继承QListWidgetItem，并添加需要的属性。

class MyListWidgetItem : public QListWidgetItem
{
public:
    MyListWidgetItem(QString text, QListWidget *parent, int id);
    int getId() const { return id;}
    void setId(int id){this->id = id;}
    void setChecked(bool checked);
private:
    bool checked;
    int id;
    QColor checkedBackgroundColor = QColor(255, 204, 204);
    QColor checkedForegroundColor = QColor(255, 0, 0);
};

在这里，我们继承了QListWidgetItem，并添加了一个id属性和一个setChecked()函数。id用于标识Item，setChecked()函数用于设置Item是否被勾选。

2. 重写paint()函数，在这里实现自定义Item的绘制。

void MyListWidgetItem::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    // 判断Item是否被勾选
    if (isChecked()) {
        painter->save();

        // 设置背景色
        painter->fillRect(option.rect, checkedBackgroundColor);

        // 绘制勾选框
        QStyleOptionButton check_box_style_option;
        check_box_style_option.state |= QStyle::State_Enabled | QStyle::State_On;
        check_box_style_option.state |= isChecked() ? QStyle::State_On : QStyle::State_Off;
        check_box_style_option.rect = QRect(option.rect.x() + 5, option.rect.y() + 5, 20, 20);
        QApplication::style()->drawControl(QStyle::CE_CheckBox, &check_box_style_option, painter);

        // 设置前景色
        painter->setPen(checkedForegroundColor);

        // 绘制文本
        QString text = this->text();
        painter->drawText(QRect(option.rect.x() + 30, option.rect.y(), option.rect.width() - 35, option.rect.height()), Qt::AlignVCenter, text);

        painter->restore();
    } else {
        // 调用默认的绘制函数
        QListWidgetItem::paint(painter, option, index);
    }
}

在这里，我们判断了Item是否被勾选，如果被勾选，就绘制自定义的勾选框和文本，并设置背景色和前景色。如果没有被勾选，就调用默认的绘制函数。

三、使用自定义Item

使用自定义Item需要以下步骤：

1. 创建QListWidget，并设置ItemDelegate。

list_widget->setItemDelegate(new MyListWidgetDelegate(list_widget));

在这里，我们设置了一个自定义ItemDelegate（MyListWidgetDelegate）。

2. 向QListWidget添加自定义Item。

for (int i = 0; i < 10; i++) {
    MyListWidgetItem *item = new MyListWidgetItem(QString("Item %1").arg(i + 1), list_widget, i);
    if (i == 1) {
        item->setChecked(true);
    }
}

在这里，我们向QListWidget添加了10个自定义Item，并且设置第二个Item为勾选状态。

3. 实现自定义的ItemDelegate。

自定义的ItemDelegate需要继承QStyledItemDelegate，并重新实现paint()函数。

class MyListWidgetDelegate : public QStyledItemDelegate
{
public:
    MyListWidgetDelegate(QListWidget *list_widget, QObject *parent = nullptr);

    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
    QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const override;

private:
    QListWidget *list_widget;
};

在paint()函数中，我们判断了当前Item的类型，如果是自定义的Item类型，就调用自定义的绘制函数。

void MyListWidgetDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    if (dynamic_cast<MyListWidgetItem *>(list_widget->item(index.row()))) {
        const MyListWidgetItem *item = dynamic_cast<const MyListWidgetItem *>(list_widget->item(index.row()));
        item->paint(painter, option, index);
    } else {
        QStyledItemDelegate::paint(painter, option, index);
    }
}

在sizeHint()函数中，我们设置了自定义Item的大小。

QSize MyListWidgetDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const
{
    if (dynamic_cast<MyListWidgetItem *>(list_widget->item(index.row()))) {
        return QSize(100, 30);
    } else {
        return QStyledItemDelegate::sizeHint(option, index);
    }
}

四、总结

QListWidget是Qt中非常常见的控件之一，可以很方便的展示一组数据，同时也支持自定义Item效果。在本文中，我们详细介绍了QListWidget如何实现自定义Item效果，并给出了一种自定义Item的实现方式。通过学习本文，相信读者可以掌握如何使用自定义Item，实现更加丰富的展示效果。