PyQtDarkTheme 技术文档

PyQtDarkTheme 技术文档

PyQtDarkTheme 项目地址: https://gitcode.com/gh_mirrors/py/PyQtDarkTheme

PyQtDarkTheme 是一个为 QtWidgets 应用程序提供扁平化暗黑主题的库，并且提供了明亮主题作为补充。其色彩设计保证了在日光下易于阅读。本文档将指导您完成安装过程，详细解释项目使用方法，并简要概述API的使用。

安装指南

发布版本安装

您可以使用 pip 来安装最新发布的稳定版：

pip install pyqtdarktheme

开发版本安装

若想获取最新的开发特性，可以通过以下命令安装：

pip install git+https://github.com/5yutan5/PyQtDarkTheme.git@main

确保您的环境已配置好支持的 Python（3.7 及以上）和 Qt（5.15 或 6.x）版本。

使用说明

PyQtDarkTheme 的核心在于轻松地应用主题到您的应用程序中。以下是快速示例：

import sys
from PySide6.QtWidgets import QApplication, QMainWindow, QPushButton
import qdarktheme

if __name__ == "__main__":
    app = QApplication(sys.argv)
    # 设置完整暗黑主题
    qdarktheme.setup_theme()
    
    main_win = QMainWindow()
    push_button = QPushButton("使用 PyQtDarkTheme!")
    main_win.setCentralWidget(push_button)
    main_win.show()

    sys.exit(app.exec())

启用HiDPI适配，需要在实例化QApplication之前调用特定函数：

qdarktheme.enable_hi_dpi()
app = QApplication(sys.argv)

对于Qt6，HiDPI支持通常是自动的。

API使用文档

PyQtDarkTheme的核心功能通过几个关键函数提供：

• setup_theme: 应用主题，接受参数来选择主题（如 "dark", "light", 或 "auto" 以跟随系统主题）。
• load_palette: 加载对应主题的QPalette。
• load_stylesheet: 加载对应主题的样式表。
• enable_hi_dpi: 如需手动启用HiDPI支持，在创建QApplication前调用。

例如，自定义主题颜色可以这样做：

custom_colors = {"primary": "#D0BCFF"}
qdarktheme.setup_theme(custom_colors=custom_colors)

项目特点

• 兼容PySide与PyQt。
• 支持同步操作系统主题及强调色（Mac、Windows、Linux）。
• 解决不同Qt版本间的风格差异。
• 提供暗黑和明亮两套QPalette与样式表。
• 能够覆盖Qt的经典标准图标。

总结

PyQtDarkTheme简化了在Qt应用中实现美观一致的主题切换过程。借助清晰的API接口，开发者能够轻松集成并定制符合个人或产品需求的界面风格。无论是追求简洁的用户体验还是高度自定义的需求，PyQtDarkTheme都提供了强大而灵活的支持。通过遵循上述文档，您可以迅速上手，为您的Qt应用穿上这层优雅的“暗夜”或“晨曦”外衣。

PyQtDarkTheme 项目地址: https://gitcode.com/gh_mirrors/py/PyQtDarkTheme