pyqttooltip

Taxttip de Pyqt

Una biblioteca de información sobre herramientas moderna y totalmente personalizable para Pyqt y Pyside

Características

• Colocación fija y automática
• Admite ubicaciones de aliento
• Triángulo personalizable
• Animaciones y retrasos personalizables
• UI totalmente personalizable y moderna
• Funciona con PyQt5 , PyQt6 , PySide2 y PySide6

Instalación

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

La información sobre herramientas se mostrará automáticamente mientras se desplaza el widget. Si desea mostrar y ocultar manualmente la información sobre herramientas, puede usar los métodos show() y hide() :

 tooltip . show ()
tooltip . hide ()

Para eliminar una información sobre herramientas, puede usar el método deleteLater() :

 tooltip . deleteLater ()

Para recibir una notificación cuando se muestra o oculta una información sobre herramientas, puede suscribirse a las señales shown y hidden :

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

Personalización

• Configuración del widget:

 tooltip . setWidget ( widget )  # Default: None

• Configuración del texto:

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

• Establecer la ubicación:

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

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

• Establecer las ubicaciones alternativas:

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

Si la información sobre herramientas no cabe en la pantalla con la colocación principal, una de las ubicaciones alternativas se eligirá en su lugar en el orden de la lista proporcionada.
Para obtener la colocación actual de la información sobre herramientas, puede usar el método getActualPlacement() .

• Habilitar o deshabilitar el triángulo:

 tooltip . setTriangleEnabled ( False )  # Default: True

• Establecer el tamaño del triángulo:

 tooltip . setTriangleSize ( 7 )  # Default: 5

• Establecer una duración:

 tooltip . setDuration ( 1000 )  # Default: 0

La duración es el tiempo en milisegundos, después de lo cual la información sobre herramientas comenzará a desvanecerse nuevamente. Si la duración se establece en 0 , la información sobre herramientas se mantendrá visible mientras el widget esté rondado.

• Configuración de las compensaciones:

 # 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 ubicación / lado tiene su propio desplazamiento para permitir la personalización completa. Cada desplazamiento es un punto Q, que se compone de un valor X e Y.
Por defecto, todas las compensaciones se establecen en QPoint(0, 0) .

• Agregar retrasos a las animaciones Fade In / Out después de flotar el widget:

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

• Establecer las duraciones de las animaciones Fade In / Out:

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

• Establecer el radio fronterizo:

 tooltip . setBorderRadius ( 0 )   # Default: 2

• Habilitar o deshabilitar el borde:

 tooltip . setBorderEnabled ( True )   # Default: False

• Configuración de colores personalizados:

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

• Configurar una fuente personalizada:

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

• Aplicar márgenes al contenido de la información sobre herramientas:

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

• Establecer un ancho máximo:

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

• Habilitar o deshabilitar el centrado de texto para el texto envuelto:

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• Habilitar o deshabilitar la sombra de caída:

 tooltip . setDropShadowEnabled ( False )  # Default: True

• Cambiar la fuerza de la sombra de caída:

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• Haciendo la información sobre herramientas translúcida:

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

Otras opciones de personalización:

Opción	Descripción	Por defecto
setShowingOnDisabled()	Si las información sobre herramientas también deben mostrarse en widgets deshabilitados	False
setFadeInEasingCurve()	La curva de flexión del desvanecimiento en la animación	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	La curva de flexión de la animación Fade Out	QEasingCurve.Type.Linear
setMarginLeft()	Establezca el margen izquierdo individualmente	12
setMarginRight()	Establezca el margen derecho individualmente	12
setMarginTop()	Establezca el margen superior individualmente	8
setMarginBottom()	Establezca el margen inferior individualmente	7

Manifestación

pyqttooltip_demo.mp4

Las demostraciones para Pyqt5, Pyqt6 y Pyside6 se pueden encontrar en la carpeta de demostración.

Para mantener la demostración simple, solo se incluyen las características más importantes. Para obtener una descripción general de todas las opciones de personalización, consulte la documentación anterior.

Pruebas

Instalación de las dependencias de prueba requeridas Pyqt6, Pytest y Cobebagey:

 pip install PyQt6 pytest coverage

Para ejecutar las pruebas con cobertura, clone este repositorio, vaya al directorio principal y ejecute:

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

Licencia

Este software tiene licencia bajo la licencia MIT.