PyQt5 QStyleOptionViewItem
类详解及常用方法
QStyleOptionViewItem
是 PyQt5 中用于 自定义视图项(如 QListView
、QTableView
中的项)样式 的核心类。它继承自 QStyleOption
,封装了视图项的绘制所需信息(如位置、状态、文本、图标等),供委托类(QStyledItemDelegate
)在渲染时使用。
一、核心功能
- 传递样式信息:包括项的位置、状态(选中/悬停/激活)、文本对齐、字体、颜色等。
- 支持自定义渲染:在
QStyledItemDelegate.paint()
方法中获取并修改样式选项。 - 平台一致性:确保项在不同操作系统下按当前样式规则正确渲染。
二、主要属性
属性 | 类型 | 说明 |
---|---|---|
index | QModelIndex | 项在模型中的索引(可获取数据角色如 Qt.DisplayRole ) |
rect | QRect | 项的绘制区域(位置和大小) |
state | QStyle.State | 项的状态(如 State_Selected 、State_MouseOver ) |
text | str | 项的显示文本 |
font | QFont | 项的字体 |
backgroundBrush | QBrush | 项的背景画刷(颜色/渐变/纹理) |
textAlignment | Qt.Alignment | 文本对齐方式(如 Qt.AlignLeft ) |
icon | QIcon | 项的图标 |
decorationSize | QSize | 图标的大小 |
features | QStyleOptionViewItem.ViewItemFeatures | 项的附加特性(如是否显示装饰图标) |
三、常用方法
1. 初始化选项对象
python
def initFrom(widget: QWidget) -> None
初始化样式选项的基础属性(如调色板、方向),通常需在自定义委托中调用。
示例:
python
option = QStyleOptionViewItem()
option.initFrom(self) # 从委托对象继承基础样式
2. 获取/修改属性
直接通过属性名访问或修改值:
python
# 设置文本颜色
option.palette.setColor(QPalette.Text, QColor("red"))
# 获取项是否被选中
is_selected = option.state & QStyle.State_Selected
四、代码示例:自定义项渲染
1. 自定义委托类
python
from PyQt5.QtWidgets import QStyledItemDelegate, QStyleOptionViewItem
from PyQt5.QtGui import QPainter, QColor, QFont
from PyQt5.QtCore import Qt
class CustomDelegate(QStyledItemDelegate):
def paint(self, painter, option, index):
# 初始化样式选项
option = QStyleOptionViewItem(option)
self.initStyleOption(option, index)
# 修改样式:选中项背景色和字体加粗
if option.state & QStyle.State_Selected:
option.backgroundBrush = QColor("#E3F2FD")
option.font.setBold(True)
# 调用父类方法继续渲染(或完全自定义绘制)
super().paint(painter, option, index)
2. 完全自定义绘制
python
def paint(self, painter, option, index):
# 初始化样式选项
option = QStyleOptionViewItem(option)
self.initStyleOption(option, index)
# 保存画笔状态
painter.save()
# 绘制背景
if option.state & QStyle.State_Selected:
painter.fillRect(option.rect, QColor("#E3F2FD"))
else:
painter.fillRect(option.rect, option.backgroundBrush)
# 绘制图标
icon_rect = option.rect.adjusted(5, 5, -5, -5)
icon_rect.setWidth(32)
option.icon.paint(painter, icon_rect, Qt.AlignLeft)
# 绘制文本
text_rect = option.rect.adjusted(40, 0, -5, 0)
painter.setFont(option.font)
painter.setPen(option.palette.color(QPalette.Text))
painter.drawText(text_rect, option.textAlignment, option.text)
# 恢复画笔状态
painter.restore()
五、关键枚举值
1. QStyle.State
状态标志
值 | 说明 |
---|---|
State_Enabled | 项已启用 |
State_Selected | 项被选中 |
State_MouseOver | 鼠标悬停在项上 |
State_HasFocus | 项获得焦点 |
2. QStyleOptionViewItem.ViewItemFeatures
特性
值 | 说明 |
---|---|
None | 无额外特性 |
WrapText | 文本自动换行 |
Alternate | 交替行背景色(用于斑马线效果) |
六、注意事项
-
对象生命周期:
QStyleOptionViewItem
通常在paint()
方法中创建,无需手动释放内存。
-
平台差异:
- 直接修改样式选项可能破坏跨平台一致性,建议优先使用委托的标准方法。
-
性能优化:
- 避免在
paint()
中频繁创建复杂对象,尽量复用资源。
- 避免在
七、应用场景
- 高亮特定项:根据数据条件(如错误状态)修改背景色或字体。
- 自定义布局:调整图标和文本的位置、间距。
- 复杂交互效果:实现悬停动画、自定义焦点框。
通过 **QStyleOptionViewItem
**,开发者可以深入控制视图项的渲染逻辑,构建高度定制化的用户界面。