Metadata-Version: 2.1
Name: pyqt-toast
Version: 0.0.14
Summary: PyQt Toast (Small message displayed on the screen, visible for a short time)
Home-page: https://github.com/yjg30737/pyqt-toast.git
Author: Jung Gyu Yoon
Author-email: yjg30737@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE


# pyqt-toast

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



## Requirements

PyQt5 >= 5.8



## Setup

`python -m pip install pyqt-toast`



## Included Packages

* <a href="https://github.com/yjg30737/pyqt-resource-helper">pyqt-resource-helper</a>



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



<b>Note:</b> 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.



## Example

Code Sample

```python

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



https://user-images.githubusercontent.com/55078043/163155105-371e5d88-8b77-4a25-90cc-5c461f841762.mp4











