Skip to content

PyQt Toast (Small message displayed on the screen, visible for a short time)

License

Notifications You must be signed in to change notification settings

yjg30737/pyqt-toast

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyqt-toast

PyQt Toast (Small message displayed on the screen, visible for a short time)

Help Wanted

If you are good at PyQt, i kindly ask you to make setDuration work :)

Requirements

PyQt5 >= 5.14

Setup

python -m pip install pyqt-toast

Usage

  • Toast(text='This is toast', duration=3, parent=self) - Constructor. Giving parent argument to self value helps toast to maintain its place after window got moved.

Note: You have to declare this one time as a class variable at initializing point(e.g. __initUi) or else new one will pop up even though last one is still showing.

  • setPosition(pos: QPoint) - Place center of the toast at the given position.
  • setFont(font: QFont) - Set the font of text in toast. Toast's size will be automatically changed based on text's size.
  • setForegroundColor(color) - Set the text(foreground) color. color argument can be both str(6-digits hex color string), QColor types.
  • setBackgroundColor(color) - Set the background color. color argument can be both str(6-digits hex color string), QColor types.
  • setOpacity(opacity: float) - Set the opacity of toast.
  • setDuration(duration: int) - Set the duration of toast. - This doesn't work currently ..
  • setAlignment(alignment) - Set the alignment of text.

Example

Code Sample

from PyQt5.QtWidgets import QWidget, QApplication, QPushButton, QGridLayout

from pyqt_toast import Toast


class ToastExample(QWidget):
    def __init__(self):
        super().__init__()
        self.__initUi()

    def __initUi(self):
        btn = QPushButton('Krabby Patty secret formula')
        self.__toast = Toast(text='The Krabby Patty formula is the sole property of the Krusty Krab and is only to be discussed in part or in whole with its creator Mr. Krabs. Duplication of this formula is punishable by law. Restrictions apply, results may vary.', duration=3, parent=self)
        btn.clicked.connect(self.__toast.show)
        lay = QGridLayout()
        lay.addWidget(btn)
        self.setLayout(lay)


if __name__ == "__main__":
    import sys

    app = QApplication(sys.argv)
    toastExample = ToastExample()
    toastExample.show()
    app.exec_()

Result

toast_example.mp4