pyqttooltip

Pyqt ToolTip

Uma biblioteca de tampa de ferramentas moderna e totalmente personalizável para Pyqt e Pyside

Características

• Colocação fixa e automática
• Suporta canais de fallback
• Triângulo personalizável
• Animações e atrasos personalizáveis
• Ui totalmente personalizável e moderna
• Trabalha com PyQt5 , PyQt6 , PySide2 e PySide6

Instalação

 pip install pyqttooltip

Uso

 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' )

A dica de ferramenta será mostrada automaticamente enquanto pairava o widget. Se você deseja mostrar e ocultar manualmente a dica de ferramenta, pode usar os métodos show() e hide() :

 tooltip . show ()
tooltip . hide ()

Para excluir uma dica de ferramenta, você pode usar o método deleteLater() :

 tooltip . deleteLater ()

Para ser notificado quando uma dica de ferramenta é mostrada ou oculta, você pode se inscrever nos sinais shown e hidden :

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

Personalização

• Definindo o widget:

 tooltip . setWidget ( widget )  # Default: None

• Definindo o texto:

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

• Definindo o posicionamento:

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

Colocação disponível:
AUTO , LEFT , RIGHT , TOP , BOTTOM

• Definindo os canais de fallback:

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

Se a dica de ferramenta não caber na tela com o posicionamento primário, um dos canais será escolhido na ordem da lista fornecida.
Para obter o posicionamento atual da dica de ferramenta, você pode usar o método getActualPlacement() .

• Habilitando ou desativando o triângulo:

 tooltip . setTriangleEnabled ( False )  # Default: True

• Definindo o tamanho do triângulo:

 tooltip . setTriangleSize ( 7 )  # Default: 5

• Definindo uma duração:

 tooltip . setDuration ( 1000 )  # Default: 0

A duração é o tempo em milissegundos, após o qual a dica de ferramenta começará a desaparecer novamente. Se a duração estiver definida como 0 , a dica de ferramenta permanecerá visível enquanto o widget for pairado.

• Definir as compensações:

 # 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 ))

Cada colocação / lateral tem seu próprio deslocamento para permitir a personalização total. Cada deslocamento é um qpoint, composto por um valor x e y.
Por padrão, todas as compensações estão definidas como QPoint(0, 0) .

• Adicionando atrasos às animações de desbotamento / saída depois de passar o widget:

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

• Definindo as durações das animações Fade In / Out:

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

• Definindo o raio da fronteira:

 tooltip . setBorderRadius ( 0 )   # Default: 2

• Habilitando ou desativando a fronteira:

 tooltip . setBorderEnabled ( True )   # Default: False

• Definindo cores personalizadas:

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

• Definindo uma fonte personalizada:

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

• Aplicando margens ao conteúdo da dica de ferramenta:

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

• Definindo uma largura máxima:

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

• Ativar ou desativar o texto centralizado para texto embrulhado:

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• Habilitando ou desativando a sombra de queda:

 tooltip . setDropShadowEnabled ( False )  # Default: True

• Mudando a força da sombra:

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• Tornando a dica de ferramenta translúcida:

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

Outras opções de personalização:

Opção	Descrição	Padrão
setShowingOnDisabled()	Se as dicas de ferramentas também devem ser mostradas em widgets desativados	False
setFadeInEasingCurve()	A curva de flexibilização do desaparecimento da animação	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	A curva de flexibilização da animação desbotada	QEasingCurve.Type.Linear
setMarginLeft()	Defina a margem esquerda individualmente	12
setMarginRight()	Defina a margem direita individualmente	12
setMarginTop()	Defina a margem superior individualmente	8
setMarginBottom()	Defina a margem inferior individualmente	7

Demonstração

pyqttooltip_demo.mp4

As demos para PYQT5, PYQT6 e PYSIDE6 podem ser encontradas na pasta demo.

Para manter a demonstração simples, apenas os recursos mais importantes estão incluídos. Para obter uma visão geral de todas as opções de personalização, consulte a documentação acima.

Testes

Instalando as dependências de teste necessárias PYQT6, Pytest e CoveragePypy:

 pip install PyQt6 pytest coverage

Para executar os testes com cobertura, clone este repositório, entre no diretório principal e corra:

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

Licença

Este software está licenciado sob a licença do MIT.