pyqttooltip

PYQT工具提示

PYQT和Pyside的现代且完全可定制的工具提示库

特征

• 固定和自动放置
• 支持后备位置
• 可自定义的三角形
• 可自定义的动画和延迟
• 完全可定制的现代用户
• 与PyQt5 ， PyQt6 ， PySide2和PySide6合作6

安装

 pip install pyqttooltip

用法

 from PyQt6 . QtWidgets import QMainWindow , QPushButton
from pyqttooltip import Tooltip , TooltipPlacement


class Window ( QMainWindow ):
    def __init__ ( self ):
        super (). __init__ ( parent = None )

        # Add button
        self . button = QPushButton ( 'Button' , self )
        
        # Add tooltip to button
        self . tooltip = Tooltip ( self . button , 'This is a tooltip' )

在悬停小部件时，将自动显示该工具提示。如果要手动显示和隐藏工具提示，则可以使用show()和hide()方法：

 tooltip . show ()
tooltip . hide ()

要删除工具提示，您可以使用deleteLater()方法：

 tooltip . deleteLater ()

要在显示或隐藏工具提示时获得通知，您可以订阅shown和hidden信号：

 tooltip . shown . connect ( lambda : print ( 'shown' ))
tooltip . hidden . connect ( lambda : print ( 'hidden' ))

定制

• 设置小部件：

 tooltip . setWidget ( widget )  # Default: None

• 设置文字：

 tooltip . setText ( 'Text of the tooltip' )  # Default: ''

• 设置位置：

 tooltip . setPlacement ( TooltipPlacement . RIGHT )  # Default: TooltipPlacement.AUTO

可用位置：
AUTO ， LEFT ， RIGHT ， TOP ， BOTTOM

• 设置后备位置：

 tooltip . setFallbackPlacements ([ TooltipPlacement . TOP , TooltipPlacement . BOTTOM ])  # Default: []

如果该工具提示在屏幕上不适合主放置，则将在提供的列表的顺序中选择其中一个后备位置。
要获取工具提示的当前放置，您可以使用getActualPlacement()方法。

• 启用或禁用三角形：

 tooltip . setTriangleEnabled ( False )  # Default: True

• 设置三角形的大小：

 tooltip . setTriangleSize ( 7 )  # Default: 5

• 设置持续时间：

 tooltip . setDuration ( 1000 )  # Default: 0

持续时间是毫秒中的时间，工具提示将再次逐渐消失。如果将持续时间设置为0 ，则只要小部件悬停，工具提示将保持可见。

• 设置偏移：

 # Setting the offset for a specific placement
tooltip . setOffsetByPlacement ( TooltipPlacement . LEFT , QPoint ( - 10 , 5 ))

# Using a dict that specifies the offset for each placement you want to set
offsets = {
    TooltipPlacement . LEFT :   QPoint ( - 10 , 5 ),
    TooltipPlacement . RIGHT :  QPoint ( 10 , 5 ),
    TooltipPlacement . TOP :    QPoint ( 5 , - 10 ),
    TooltipPlacement . BOTTOM : QPoint ( 5 , 10 )
}
tooltip . setOffsets ( offsets )

# Setting the offsets for all the placements to a single value
tooltip . setOffsetsAll ( QPoint ( 10 , 5 ))

每个位置 /侧面都有自己的偏移量，以允许完整的可自定义性。每个偏移量都是一个QPoint，由X和Y值组成。
默认情况下，所有偏移都设置为QPoint(0, 0) 。

• 悬停在小部件之后，将延迟延迟到淡入 /输出动画：

 tooltip . setShowDelay ( 500 )  # Default: 50
tooltip . setHideDelay ( 500 )  # Default: 50

• 设置淡出的淡入 /输出动画的持续时间：

 tooltip . setFadeInDuration ( 250 )   # Default: 150
tooltip . setFadeOutDuration ( 250 )  # Default: 150

• 设置边界半径：

 tooltip . setBorderRadius ( 0 )   # Default: 2

• 启用或禁用边界：

 tooltip . setBorderEnabled ( True )   # Default: False

• 设置自定义颜色：

 tooltip . setBackgroundColor ( QColor ( '#FCBA03' ))   # Default: QColor('#111214')
tooltip . setTextColor ( QColor ( '#000000' ))         # Default: QColor('#CFD2D5')
tooltip . setBorderColor ( QColor ( '#A38329' ))       # Default: QColor('#403E41')

• 设置自定义字体：

 tooltip . setFont ( QFont ( 'Consolas' , 10 ))  # Default: QFont('Arial', 9, QFont.Weight.Bold)

• 将保证金应用于工具提示的内容：

 tooltip . setMargins ( QMargins ( 10 , 8 , 10 , 8 ))  # Default: QMargins(12, 8, 12, 7)

• 设置最大宽度：

 tooltip . setMaximumWidth ( 150 )  # Default: 16777215 (QWIDGETSIZE_MAX)

• 启用或禁用包装文本中心的文本中心：

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• 启用或禁用落下阴影：

 tooltip . setDropShadowEnabled ( False )  # Default: True

• 改变阴影强度：

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• 使工具提示半透明：

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

其他自定义选项：

选项	描述	默认
setShowingOnDisabled()	是否还应在残疾的小部件上显示工具提示	False
setFadeInEasingCurve()	动画中淡出的宽松曲线	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	淡出动画的宽松曲线	QEasingCurve.Type.Linear
setMarginLeft()	单独设置左路	12
setMarginRight()	单独设置右键	12
setMarginTop()	单独设置最高边距	8
setMarginBottom()	单独设置底部边距	7

演示

pyqttooltip_demo.mp4

可以在演示文件夹中找到PYQT5，PYQT6和Pyside6的演示。

为了保持演示简单，只有最重要的功能包括在内。要获取所有自定义选项的概述，请查看上面的文档。

测试

安装所需的测试依赖项pyqt6，pytest和Coveragepy：

 pip install PyQt6 pytest coverage

要使用覆盖范围进行测试，请克隆此存储库，进入主要目录并运行：

 coverage run -m pytest
coverage report --ignore-errors -m

执照

该软件已根据MIT许可获得许可。