pyqttooltip

Info-bulle pyqt

Une bibliothèque d'info-bulle moderne et entièrement personnalisable pour PYQT et PYSIDE

Caractéristiques

• Placement fixe et automatique
• Prend en charge les placements de secours
• Triangle personnalisable
• Animations et retards personnalisables
• UI entièrement personnalisable et moderne
• Fonctionne avec PyQt5 , PyQt6 , PySide2 et PySide6

Installation

 pip install pyqttooltip

Usage

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

L'info-bulle sera automatiquement affichée tout en survolant le widget. Si vous souhaitez afficher et masquer manuellement l'info-bulle, vous pouvez utiliser les méthodes show() et hide() :

 tooltip . show ()
tooltip . hide ()

Pour supprimer une info-bulle, vous pouvez utiliser la méthode deleteLater() :

 tooltip . deleteLater ()

Pour être notifié lorsqu'une info-bulle est affichée ou masquée, vous pouvez vous abonner aux signaux shown et hidden :

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

Personnalisation

• Définition du widget:

 tooltip . setWidget ( widget )  # Default: None

• Définition du texte:

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

• Réglage du placement:

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

Placements disponibles:
AUTO , LEFT , RIGHT , TOP , BOTTOM

• Définition des placements de secours:

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

Si l'info-bulle ne s'adapte pas à l'écran avec le placement principal, l'un des emplacements de secours sera choisi à la place de l'ordre de la liste fournie.
Pour obtenir le placement actuel de l'info-bulle, vous pouvez utiliser la méthode getActualPlacement() .

• Activer ou désactiver le triangle:

 tooltip . setTriangleEnabled ( False )  # Default: True

• Réglage de la taille du triangle:

 tooltip . setTriangleSize ( 7 )  # Default: 5

• Définition d'une durée:

 tooltip . setDuration ( 1000 )  # Default: 0

La durée est le temps en millisecondes, après quoi l'info-bulle recommencera. Si la durée est définie sur 0 , l'info-bulle restera visible aussi longtemps que le widget est en plané.

• Réglage des décalages:

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

Chaque placement / côté a son propre décalage pour permettre une personnalisation complète. Chaque décalage est un Qpoint, qui est composé d'une valeur x et y.
Par défaut, tous les décalages sont définis sur QPoint(0, 0) .

• Ajout de retards aux animations fondues dans / out après avoir plané le widget:

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

• Définir les durées des animations de fondu dans / out:

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

• Régler le rayon de bordure:

 tooltip . setBorderRadius ( 0 )   # Default: 2

• Activer ou désactiver la frontière:

 tooltip . setBorderEnabled ( True )   # Default: False

• Réglage des couleurs personnalisées:

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

• Définition d'une police personnalisée:

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

• Application des marges au contenu de l'info-bulle:

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

• Réglage d'une largeur maximale:

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

• Activation ou désactiver le centre de texte pour le texte enveloppé:

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• Activer ou désactiver l'ombre de dépôt:

 tooltip . setDropShadowEnabled ( False )  # Default: True

• Changer la force de l'ombre de la goutte:

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• Rendre la translucide d'info-bulle:

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

Autres options de personnalisation:

Option	Description	Défaut
setShowingOnDisabled()	Si les info-bulles doivent également être affichées sur les widgets désactivés	False
setFadeInEasingCurve()	La courbe d'assouplissement du fondu dans l'animation	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	La courbe d'assouplissement de l'animation de la décoloration	QEasingCurve.Type.Linear
setMarginLeft()	Réglez la marge gauche individuellement	12
setMarginRight()	Réglez la marge droite individuellement	12
setMarginTop()	Régler la marge supérieure individuellement	8
setMarginBottom()	Régler la marge inférieure individuellement	7

Démo

pyqttooltip_demo.mp4

Les démos de Pyqt5, Pyqt6 et Pyside6 peuvent être trouvées dans le dossier de démonstration.

Pour garder la démo simple, seules les fonctionnalités les plus importantes sont incluses. Pour obtenir un aperçu de toutes les options de personnalisation, consultez la documentation ci-dessus.

Tests

Installation des dépendances de test requises PYQT6, PYTEST et COVERAGEPY:

 pip install PyQt6 pytest coverage

Pour exécuter les tests avec une couverture, clonez ce référentiel, allez dans le répertoire principal et exécutez:

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

Licence

Ce logiciel est concédé sous licence MIT.