pyqttooltip

คำแนะนำเครื่องมือ PYQT

ห้องสมุดคำแนะนำเครื่องมือเครื่องมือที่ทันสมัยและปรับแต่งได้อย่างสมบูรณ์สำหรับ PYQT และ Pyside

คุณสมบัติ

• ตำแหน่งคงที่และอัตโนมัติ
• รองรับตำแหน่งทางเลือก
• สามเหลี่ยมที่ปรับแต่งได้
• ภาพเคลื่อนไหวและความล่าช้าที่ปรับแต่งได้
• UI ที่ปรับแต่งได้อย่างเต็มที่และทันสมัย
• ทำงานร่วมกับ PyQt5 , PyQt6 , PySide2 และ PySide6

การติดตั้ง

 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

• การตั้งค่าระยะเวลาของอนิเมชั่น Fade In / Out:

 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

• การเปิดใช้งานหรือปิดใช้งาน Shadow Drop:

 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