pyqttooltip

Pyqt Tooltip

Eine moderne und vollständig anpassbare Tooltip -Bibliothek für PYQT und Pyside

Merkmale

• Behobene und automatische Platzierung
• Unterstützt Fallback -Platzierungen
• Anpassbares Dreieck
• Anpassbare Animationen und Verzögerungen
• Voll anpassbare und moderne Benutzeroberfläche
• Arbeitet mit PyQt5 , PyQt6 , PySide2 und PySide6

Installation

 pip install pyqttooltip

Verwendung

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

Der Tooltip wird automatisch angezeigt, während das Widget schwebt. Wenn Sie den Tooltip manuell anzeigen und verstecken möchten, können Sie die Methoden show() und hide() verwenden:

 tooltip . show ()
tooltip . hide ()

Um einen Tooltip zu löschen, können Sie die Methode deleteLater() verwenden:

 tooltip . deleteLater ()

Um benachrichtigt zu werden, wenn ein Tooltip angezeigt oder versteckt wird, können Sie die shown und hidden Signale abonnieren:

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

Anpassung

• Einstellen des Widgets:

 tooltip . setWidget ( widget )  # Default: None

• Einstellen des Textes:

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

• Einstellen der Platzierung:

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

Verfügbare Platzierungen:
AUTO , LEFT , RIGHT , TOP , BOTTOM

• Einstellen der Fallback -Platzierungen:

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

Wenn der Tooltip nicht mit der primären Platzierung auf den Bildschirm passt, wird stattdessen eine der Fallback -Platzierungen in der Reihenfolge der angegebenen Liste ausgewählt.
Um die aktuelle Platzierung des Tooltip zu erhalten, können Sie die Methode getActualPlacement() verwenden.

• Aktivieren oder Deaktivieren des Dreiecks:

 tooltip . setTriangleEnabled ( False )  # Default: True

• Setzen Sie die Größe des Dreiecks:

 tooltip . setTriangleSize ( 7 )  # Default: 5

• Setzen einer Dauer:

 tooltip . setDuration ( 1000 )  # Default: 0

Die Dauer ist die Zeit in Millisekunden, nach der der Tooltip wieder verblasst. Wenn die Dauer auf 0 eingestellt ist, bleibt der Tooltip so lange sichtbar, wie das Widget schwebt.

• Einstellen der Offsets:

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

Jede Platzierung / Seite hat einen eigenen Versatz, um eine vollständige Anpassungsfähigkeit zu ermöglichen. Jeder Offset ist ein Qpoint, der aus einem X- und Y -Wert besteht.
Standardmäßig sind alle Offsets auf QPoint(0, 0) eingestellt.

• Hinzufügen von Verzögerungen zum Fade In / Out -Animationen, nachdem Sie das Widget schweben:

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

• Setzen Sie die Dauer der Fade In / Out -Animationen:

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

• Setzen Sie den Grenzradius:

 tooltip . setBorderRadius ( 0 )   # Default: 2

• Aktivieren oder Deaktivieren der Grenze:

 tooltip . setBorderEnabled ( True )   # Default: False

• Setzen Sie benutzerdefinierte Farben:

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

• Einstellen einer benutzerdefinierten Schriftart:

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

• Ränder auf den Inhalt des Tooltip anwenden:

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

• Einstellen einer maximalen Breite:

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

• Aktivieren oder Deaktivieren von Textzentrieren für verpackte Text:

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• Aktivieren oder Deaktivieren des Drop -Schattens:

 tooltip . setDropShadowEnabled ( False )  # Default: True

• Ändern der Drop -Schattenstärke:

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• Machen Sie den Tooltip durchscheinend:

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

Andere Anpassungsoptionen:

Option	Beschreibung	Standard
setShowingOnDisabled()	Ob die Tooltips auch auf deaktivierten Widgets angezeigt werden sollten	False
setFadeInEasingCurve()	Die lockere Kurve des Verblassen in der Animation	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	Die lockere Kurve der Fade -Out -Animation	QEasingCurve.Type.Linear
setMarginLeft()	Setzen Sie den linken Rand einzeln ein	12
setMarginRight()	Stellen Sie den rechten Rand einzeln ein	12
setMarginTop()	Stellen Sie den oberen Rand einzeln ein	8
setMarginBottom()	Einen Untermargen einzeln einstellen	7

Demo

pyqttooltip_demo.mp4

Die Demos für PYQT5, PYQT6 und Pyside6 finden Sie im Demo -Ordner.

Um die Demo einfach zu halten, sind nur die wichtigsten Funktionen enthalten. Um einen Überblick über alle Anpassungsoptionen zu erhalten, lesen Sie die obige Dokumentation.

Tests

Installation der erforderlichen Testabhängigkeiten PYQT6, PyTest und CoveragePy:

 pip install PyQt6 pytest coverage

Um die Tests mit Abdeckung durchzuführen, klonen Sie dieses Repository, gehen Sie in das Hauptverzeichnis und rennen Sie:

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

Lizenz

Diese Software ist unter der MIT -Lizenz lizenziert.