【python】PyQt5中QToolButton的详细用法教学与应用实战

在这里插入图片描述

✨✨ 欢迎大家来到景天科技苑✨✨

🎈🎈 养成好习惯，先赞后看哦~🎈🎈

🏆 作者简介：景天科技苑
🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。
🏆《博客》：Python全栈，前后端开发，小程序开发，云原生K8S，人工智能，js逆向，App逆向，网络系统安全，数据分析，PyQt5和tkinter桌面开发，Django，fastapi，flask等框架，linux，shell脚本等实操经验，网站搭建，数据库等分享。

所属的专栏：PyQt5桌面应用开发，零基础到进阶应用实战
景天的主页：景天科技苑

在这里插入图片描述

文章目录

QToolButton
- 引言
- 1. QToolButton简介
- - 1.1 继承关系
  - 1.2 常用场景
- 2. QToolButton的创建与基本设置
- - 2.1 创建QToolButton
  - 2.2 设置文本和图标
  - 2.3 设置图标大小
  - 2.4 设置工具提示
  - 2.5 设置按钮样式
- 3. QToolButton的进阶设置
- - 3.1 设置箭头类型
  - 3.2 自动提升效果
  - 3.3 菜单设置
  - 3.4 可检查状态
  - 3.5 自定义大小与布局
- 4. 实际应用案例
- - 4.1 创建工具栏
  - 4.2 使用QToolButton实现状态切换
- 5. 总结
- - 5.1 自定义图标和文本的位置
  - 5.2 使用`QToolButton`作为按钮组
  - 5.3 禁用文本显示
  - 5.4 响应鼠标悬停事件
  - 5.5 动画效果

QToolButton

引言

在PyQt5中，QToolButton是一个用于快速访问命令或选项的按钮控件，通常用在工具栏（QToolBar）中。与标准的QPushButton相比，QToolButton的设计更为紧凑，通常只显示图标或图标与简短文本的组合。本教程将详细介绍QToolButton的常用方法、属性设置以及实际应用案例，帮助读者更好地理解和使用这一控件。

在这里插入图片描述

1. QToolButton简介

QToolButton是PyQt5中用于创建工具栏按钮的类，它继承自QAbstractButton。工具按钮通常用于快速访问特定的命令或选项，与工具栏紧密相关。它们通常不显示文本标签，而是显示一个图标，但也可以同时显示图标和文本。

1.1 继承关系

QToolButton的继承关系如下：

QObject
  └── QAbstractButton
       └── QToolButton

1.2 常用场景

工具栏中的按钮：最常见的用途是作为工具栏中的一部分，提供快速访问常用功能的按钮。
状态切换：如绘图程序中的“笔”工具按钮，用于切换不同的绘图模式。
弹出菜单：通过setMenu()和setPopupMode()方法，可以为QToolButton设置弹出菜单，实现更丰富的交互。

2. QToolButton的创建与基本设置

2.1 创建QToolButton

创建QToolButton的基本语法如下：

from PyQt5.QtWidgets import QToolButton

# 假设有一个QWidget或QMainWindow实例名为window
tool_button = QToolButton(window)

2.2 设置文本和图标

使用setText()和setIcon()方法可以分别为QToolButton设置文本和图标。

from PyQt5.QtGui import QIcon

tool_button.setText("工具")
tool_button.setIcon(QIcon('icon.png'))

2.3 设置图标大小

使用setIconSize()方法可以设置图标的尺寸。

tool_button.setIconSize(QtCore.QSize(32, 32))

2.4 设置工具提示

通过setToolTip()方法可以为QToolButton设置工具提示，当鼠标悬停在按钮上时显示。

tool_button.setToolTip("这是一个工具按钮")

2.5 设置按钮样式

QToolButton提供了多种样式来定义文本和图标的显示方式，通过setToolButtonStyle()方法设置。

from PyQt5.QtCore import Qt

# 只显示图标
tool_button.setToolButtonStyle(Qt.ToolButtonIconOnly)

# 只显示文本
tool_button.setToolButtonStyle(Qt.ToolButtonTextOnly)

# 文本显示在图标旁边
tool_button.setToolButtonStyle(Qt.ToolButtonTextBesideIcon)

# 文本显示在图标下方
tool_button.setToolButtonStyle(Qt.ToolButtonTextUnderIcon)

# 遵循系统风格
tool_button.setToolButtonStyle(Qt.ToolButtonFollowStyle)

3. QToolButton的进阶设置

3.1 设置箭头类型

在这里插入图片描述

QToolButton可以显示一个箭头而不是图标，通过setArrowType()方法设置。

# 无箭头
tool_button.setArrowType(Qt.NoArrow)

# 向上箭头
tool_button.setArrowType(Qt.UpArrow)

# 向下箭头
tool_button.setArrowType(Qt.DownArrow)

# 向左箭头
tool_button.setArrowType(Qt.LeftArrow)

# 向右箭头
tool_button.setArrowType(Qt.RightArrow)

3.2 自动提升效果

在这里插入图片描述

QToolButton支持自动浮起效果，即当鼠标悬停在按钮上时，按钮会呈现3D效果。通过setAutoRaise()方法可以设置是否启用此效果。

tool_button.setAutoRaise(True)

3.3 菜单设置

在这里插入图片描述

QToolButton可以设置一个弹出菜单，通过setMenu()和setPopupMode()方法实现。

from PyQt5.QtWidgets import QMenu, QAction

# 创建菜单和动作
menu = QMenu(tool_button)
action1 = QAction("选项1", tool_button)
action2 = QAction("选项2", tool_button)

# 将动作添加到菜单

menu.addAction(action1)
menu.addAction(action2)

# 设置弹出菜单
tool_button.setMenu(menu)

# 设置弹出菜单的显示模式
# Qt.DelayedPopup：当按钮被点击并释放后显示菜单
# Qt.InstantPopup：当按钮被点击时立即显示菜单
# Qt.MenuButtonPopup：按钮旁边始终显示一个小的箭头，点击箭头时显示菜单
tool_button.setPopupMode(Qt.DelayedPopup)

# 连接动作信号到槽函数（示例）
action1.triggered.connect(lambda: print("选项1被点击"))
action2.triggered.connect(lambda: print("选项2被点击"))

3.4 可检查状态

QToolButton可以设置为可检查状态，类似于复选框的行为。通过setCheckable()方法设置，并通过isChecked()方法获取当前状态。

tool_button.setCheckable(True)

# 检查按钮是否被选中
if tool_button.isChecked():
    print("按钮被选中")
else:
    print("按钮未被选中")

# 也可以通过点击信号来切换状态
tool_button.clicked.connect(lambda: print(f"按钮状态：{'选中' if tool_button.isChecked() else '未选中'}"))

3.5 自定义大小与布局

QToolButton的大小默认是自动调整的，但你也可以通过setFixedSize()或setGeometry()方法来手动设置其大小。此外，还可以结合布局管理器（如QHBoxLayout、QVBoxLayout等）来更好地控制QToolButton的布局。

# 设置固定大小
tool_button.setFixedSize(100, 50)

# 或者在布局中设置
# 假设你有一个布局实例layout
# layout.addWidget(tool_button)

4. 实际应用案例

4.1 创建工具栏

在图形用户界面（GUI）程序中，QToolButton经常与QToolBar结合使用，以创建包含多个快速访问按钮的工具栏。

from PyQt5.QtWidgets import QApplication, QMainWindow, QToolBar

class MainWindow(QMainWindow):
    def __init__(self):
        super().__init__()

        # 初始化工具栏
        self.toolbar = QToolBar(self)
        self.addToolBar(self.toolbar)

        # 创建并添加QToolButton到工具栏
        btn1 = QToolButton(self)
        btn1.setIcon(QIcon('icon1.png'))
        btn1.setToolTip('按钮1')
        self.toolbar.addWidget(btn1)

        btn2 = QToolButton(self)
        btn2.setIcon(QIcon('icon2.png'))
        btn2.setToolTip('按钮2')
        btn2.setCheckable(True)  # 设置为可检查状态
        self.toolbar.addWidget(btn2)

        # 更多按钮...

# 创建应用程序实例并运行
app = QApplication([])
window = MainWindow()
window.show()
app.exec_()

4.2 使用QToolButton实现状态切换

在绘图或编辑软件中，QToolButton常用于实现状态的切换，如从“选择”模式切换到“编辑”模式。

# 假设有两个QToolButton实例，btn_select 和 btn_edit
btn_select.setIcon(QIcon('select.png'))
btn_select.setToolTip('选择模式')
btn_select.setCheckable(True)

btn_edit.setIcon(QIcon('edit.png'))
btn_edit.setToolTip('编辑模式')
btn_edit.setCheckable(True)

# 连接到槽函数来切换模式（这里省略了槽函数的实现）
btn_select.clicked.connect(self.toggleSelectMode)
btn_edit.clicked.connect(self.toggleEditMode)

# 示例槽函数
def toggleSelectMode(self):
    if btn_select.isChecked():
        # 切换到选择模式
        pass

def toggleEditMode(self):
    if btn_edit.isChecked():
        # 切换到编辑模式
        pass

# 注意：上面的槽函数示例仅用于说明，实际使用时需要确保按钮实例和方法属于同一个类或以某种方式相互访问

5. 总结

QToolButton是PyQt5中一个非常实用的控件，特别适合用于工具栏中的快速访问按钮。通过本教程，我们学习了如何创建QToolButton、设置其文本、图标、菜单、可检查状态以及如何在布局中使用它。下面将进一步探讨QToolButton的一些高级用法和技巧。

5.1 自定义图标和文本的位置

默认情况下，QToolButton中的图标和文本是水平排列的，但你可以通过样式表（StyleSheet）来自定义它们的位置和外观。

# 自定义图标和文本的样式
tool_button.setStyleSheet("""
    QToolButton {
        border: none;
        background-color: transparent;
    }
    
    QToolButton:checked {
        background-color: lightgray;
    }
    
    QToolButton QIcon {
        margin-right: 5px; /* 在图标和文本之间添加间距 */
    }
    
    /* 自定义文本位置（注意：通常不直接通过样式表控制文本位置，这里仅作为样式表使用示例） */
    /* 文本位置通常需要结合布局或图标大小来间接调整 */
""")

# 注意：样式表通常不直接控制文本在图标旁边的具体位置，
# 因为这更多依赖于按钮的自动布局机制。你可能需要通过调整图标大小、文本间距或按钮大小来间接实现。

5.2 使用`QToolButton`作为按钮组

如果你有一组互斥的QToolButton（即一次只能选中一个），你可以将它们与QButtonGroup结合使用，以更方便地管理它们的状态。

from PyQt5.QtWidgets import QButtonGroup

# 假设有btn1, btn2, btn3三个QToolButton实例
group = QButtonGroup()
group.addButton(btn1)
group.addButton(btn2)
group.addButton(btn3)

# 连接按钮组的信号到槽函数
group.buttonClicked.connect(self.onButtonGroupClicked)

def onButtonGroupClicked(self, button):
    print(f"选中了按钮：{button.text()}")
    # 可以在这里根据选中的按钮执行不同的操作

5.3 禁用文本显示

如果你只想显示图标而不显示文本，可以通过设置toolButtonStyle属性来实现。

tool_button.setToolButtonStyle(Qt.ToolButtonIconOnly)

5.4 响应鼠标悬停事件

你可以通过重写QToolButton的enterEvent和leaveEvent方法来响应鼠标悬停事件，或者连接其hover信号（如果存在的话，注意QToolButton本身没有直接的hover信号，但可以通过安装事件过滤器或使用QToolTip等方式间接实现）。

# 示例：通过事件过滤器响应鼠标悬停
def eventFilter(self, source, event):
    if event.type() == QEvent.HoverEnter:
        print("鼠标悬停进入")
        # 可以改变按钮的外观或执行其他操作
    elif event.type() == QEvent.HoverLeave:
        print("鼠标悬停离开")
        # 恢复按钮的原始外观或执行清理操作
    return super().eventFilter(source, event)

# 将事件过滤器安装到tool_button上
tool_button.installEventFilter(self)  # 假设这段代码在包含eventFilter方法的类中

5.5 动画效果

虽然QToolButton本身不直接提供动画效果，但你可以通过QPropertyAnimation等类为按钮添加动画，如点击时的缩放、颜色变化等。

# 示例：使用QPropertyAnimation为按钮添加点击时的缩放动画（这里仅提供概念性代码）
# 注意：实际实现时，需要确保动画属性（如size）与按钮的实际属性相关联，并正确设置动画的起始值和结束值
# ...
# 创建并配置QPropertyAnimation实例
# ...
# 连接按钮的clicked信号到动画的start方法
# tool_button.clicked.connect(animation.start)

这些高级用法和技巧可以帮助你更好地利用QToolButton，在PyQt5应用程序中创建更加丰富和交互式的用户界面。