Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yjg30737/pyqt-explanation-balloon
PyQt explanation balloon
https://github.com/yjg30737/pyqt-explanation-balloon
balloon explanation-balloon gui-balloon pyqt pyqt-examples pyqt-gui pyqt5 qpainter qpainterpath qt qt-gui qt5
Last synced: about 1 month ago
JSON representation
PyQt explanation balloon
- Host: GitHub
- URL: https://github.com/yjg30737/pyqt-explanation-balloon
- Owner: yjg30737
- License: mit
- Created: 2022-06-13T01:22:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-09T00:46:39.000Z (over 2 years ago)
- Last Synced: 2024-04-25T17:21:46.072Z (10 months ago)
- Topics: balloon, explanation-balloon, gui-balloon, pyqt, pyqt-examples, pyqt-gui, pyqt5, qpainter, qpainterpath, qt, qt-gui, qt5
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyqt-explanation-balloon
PyQt explanation balloon
## Requirements
* PyQt5 >= 5.8
## Setup
`python -m pip install pyqt-explanation-balloon`
## Preview
Explanation balloon can be used to explain certain widget. You can close this balloon with X button at the top right.
You can set the widget which you want to describe with balloon.
You can also set the size and content of balloon with constructor. Check the class overview below.
This explanation balloon is perfectly responsive to window's resize/move/activate/deactivate event.
Text alignment is set to the center, word is wrapped at word boundaries.
## Class/Method Overview
* `ExplanationBalloon(widget, width: float, height: float, text: str)` - Constructor. `widget` is the widget which is supposed to be explained by explanation balloon.
* `setBackgroundColor(color: QColor)` - Set the background color. Text color will be also changed automatically based on background color.
* `setFont(font: QFont)` - Default function of Qt. You can set the font of text.
## Example
```python
from PyQt5.QtGui import QFont, QColor
from PyQt5.QtWidgets import QMainWindow, QPushButton, QApplication, QVBoxLayout, QWidget
from pyqt_explanation_balloon.explanationBalloon import ExplanationBalloon
class MainWindow(QMainWindow):
def __init__(self):
super().__init__()
self.__initUi()
def __initUi(self):
btn = QPushButton('Show explanation balloon')
lay = QVBoxLayout()
lay.addWidget(btn)
mainWidget = QWidget()
mainWidget.setLayout(lay)
self.setCentralWidget(mainWidget)
self.__eb = ExplanationBalloon(btn, 300.0, 200.0, 'This is explanation balloon made out of PyQt')
self.__eb.setFont(QFont('Arial', 14))
self.__eb.setBackgroundColor(QColor(50, 50, 50, 255))
btn.clicked.connect(self.__eb.show)
if __name__ == "__main__":
import sys
app = QApplication(sys.argv)
mainWindow = MainWindow()
mainWindow.show()
sys.exit(app.exec_())
```
Result
