pyqttooltip

Pyqt tooltip

Perpustakaan tooltip yang modern dan sepenuhnya dapat disesuaikan untuk PYQT dan Pyside

Fitur

• Penempatan tetap dan otomatis
• Mendukung penempatan fallback
• Segitiga yang dapat disesuaikan
• Animasi dan penundaan yang dapat disesuaikan
• UI yang sepenuhnya dapat disesuaikan dan modern
• Bekerja dengan PyQt5 , PyQt6 , PySide2 , dan PySide6

Instalasi

 pip install pyqttooltip

Penggunaan

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

Tooltip akan secara otomatis ditampilkan saat melayang -layang widget. Jika Anda ingin secara manual menunjukkan dan menyembunyikan tooltip, Anda dapat menggunakan metode show() dan hide() :

 tooltip . show ()
tooltip . hide ()

Untuk menghapus tooltip, Anda dapat menggunakan metode deleteLater() :

 tooltip . deleteLater ()

Untuk mendapatkan pemberitahuan ketika tooltip ditampilkan atau disembunyikan, Anda dapat berlangganan sinyal shown dan hidden :

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

Kustomisasi

• Mengatur widget:

 tooltip . setWidget ( widget )  # Default: None

• Mengatur teks:

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

• Mengatur penempatan:

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

Penempatan yang tersedia:
AUTO , LEFT , RIGHT , TOP , BOTTOM

• Mengatur penempatan fallback:

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

Jika tooltip tidak sesuai dengan layar dengan penempatan utama, salah satu penempatan fallback akan dipilih sebagai gantinya dalam urutan daftar yang disediakan.
Untuk mendapatkan penempatan tooltip saat ini, Anda dapat menggunakan metode getActualPlacement() .

• Mengaktifkan atau menonaktifkan segitiga:

 tooltip . setTriangleEnabled ( False )  # Default: True

• Mengatur ukuran segitiga:

 tooltip . setTriangleSize ( 7 )  # Default: 5

• Mengatur durasi:

 tooltip . setDuration ( 1000 )  # Default: 0

Durasinya adalah waktu dalam milidetik setelah itu tooltip akan mulai memudar lagi. Jika durasi diatur ke 0 , tooltip akan tetap terlihat selama widget dilayang.

• Mengatur offset:

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

Setiap penempatan / sisi memiliki offset sendiri untuk memungkinkan penyesuaian penuh. Setiap offset adalah qpoint, yang terdiri dari nilai x dan y.
Secara default, semua offset diatur ke QPoint(0, 0) .

• Menambahkan penundaan ke animasi fade in / out setelah melayang -layang:

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

• Mengatur durasi animasi fade in / out:

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

• Mengatur jari -jari perbatasan:

 tooltip . setBorderRadius ( 0 )   # Default: 2

• Mengaktifkan atau menonaktifkan perbatasan:

 tooltip . setBorderEnabled ( True )   # Default: False

• Mengatur Warna Kustom:

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

• Mengatur font khusus:

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

• Menerapkan margin ke konten tooltip:

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

• Mengatur lebar maksimum:

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

• Mengaktifkan atau menonaktifkan pemusatan teks untuk teks yang dibungkus:

 tooltip . setTextCenteringEnabled ( False )  # Default: True

• Mengaktifkan atau menonaktifkan drop shadow:

 tooltip . setDropShadowEnabled ( False )  # Default: True

• Mengubah kekuatan drop shadow:

 tooltip . setDropShadowStrength ( 3.5 )  # Default: 2.0

• Membuat Tooltip Translucent:

 tooltip . setOpacity ( 0.8 )  # Default: 1.0

Opsi Kustomisasi Lainnya:

Pilihan	Keterangan	Bawaan
setShowingOnDisabled()	Apakah tooltips juga harus ditampilkan pada widget yang dinonaktifkan	False
setFadeInEasingCurve()	Kurva pelonggaran fade dalam animasi	QEasingCurve.Type.Linear
setFadeOutEasingCurve()	Kurva pelonggaran animasi fade out	QEasingCurve.Type.Linear
setMarginLeft()	Atur margin kiri secara individual	12
setMarginRight()	Atur margin yang tepat secara individual	12
setMarginTop()	Atur margin atas secara individual	8
setMarginBottom()	Atur margin bawah secara individual	7

Demo

pyqttooltip_demo.mp4

Demo untuk pyqt5, pyqt6, dan pyside6 dapat ditemukan di folder demo.

Agar demo tetap sederhana, hanya fitur terpenting yang disertakan. Untuk mendapatkan gambaran umum dari semua opsi kustomisasi, lihat dokumentasi di atas.

Tes

Memasang dependensi tes yang diperlukan pyqt6, pytest, dan coveragepy:

 pip install PyQt6 pytest coverage

Untuk menjalankan tes dengan cakupan, klon repositori ini, masuk ke direktori utama dan jalankan:

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

Lisensi

Perangkat lunak ini dilisensikan di bawah lisensi MIT.