ZToolTip 2.0.0__tar.gz

ztooltip-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 FaBuLuZz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ztooltip-2.0.0/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: ZToolTip
+Version: 2.0.0
+Summary: A modern and fully customizable tooltip library for PyQt and PySide
+Author: FaBuLuZz
+License: MIT
+Project-URL: Homepage, https://github.com/FaBuLuZz/ZToolTip
+Keywords: python,qt,pyqt,pyside,tooltip,modern
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pywin32>=311
+Requires-Dist: QtPy>=2.4.1
+Dynamic: license-file
+
+# ZToolTip
+
+[![PyPI](https://img.shields.io/badge/pypi-v2.0.0-blue)](https://pypi.org/project/ZToolTip/)
+[![Python](https://img.shields.io/badge/python-3.7+-blue)](https://github.com/FaBuLuZz/ZToolTip)
+[![Build](https://img.shields.io/badge/build-passing-neon)](https://github.com/FaBuLuZz/ZToolTip)
+[![Coverage](https://img.shields.io/badge/coverage-91%25-green)](https://github.com/FaBuLuZz/ZToolTip)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/FaBuLuZz/ZToolTip/blob/master/LICENSE)
+
+Forked from [pyqttooltip](https://github.com/niklashenning/pyqttooltip) by [Niklas Henning](https://github.com/niklashenning)
+
+A modern and fully customizable tooltip library for PyQt and PySide
+
+![ZToolTip](https://github.com/user-attachments/assets/0313ffc7-560b-4665-a652-e1e2601fcbaa)
+
+## Features
+
+- Fixed and automatic placement
+- Customizable triangle
+- Customizable animations and delays
+- Fully customizable and modern UI
+- Works with `PyQt5`, `PyQt6`, `PySide2`, and `PySide6`
+
+## Installation
+
+```sh
+pip install ztooltip
+```
+
+## Usage
+
+```python
+from PyQt6.QtWidgets import QMainWindow, QPushButton
+from ztooltip 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')
+```
+
+The tooltip will automatically be shown while hovering the widget. If you want to manually
+show and hide the tooltip, you can use the `show()` and `hide()` methods:
+
+```python
+tooltip.show()
+tooltip.hide()
+```
+
+To delete a tooltip, you can use the `deleteLater()` method:
+
+```python
+tooltip.deleteLater()
+```
+
+To get notified when a tooltip gets shown or hidden, you can subscribe to the `shown` and `hidden` signals:
+
+```python
+tooltip.shown.connect(lambda: print('shown'))
+tooltip.hidden.connect(lambda: print('hidden'))
+```
+
+## Customization
+
+* **Setting the widget:**
+
+```python
+tooltip.setWidget(widget)  # Default: None
+```
+
+* **Setting the text:**
+
+```python
+tooltip.setText('Text of the tooltip')  # Default: ''
+```
+
+* **Setting the placement:**
+
+```python
+tooltip.setPlacement(TooltipPlacement.RIGHT)  # Default: TooltipPlacement.AUTO
+```
+
+> **AVAILABLE PLACEMENTS:** <br> `AUTO`, `LEFT`, `RIGHT`, `TOP`, `BOTTOM`
+
+* **Enabling or disabling the triangle:**
+
+```python
+tooltip.setTriangleEnabled(False)  # Default: True
+```
+
+* **Setting the size of the triangle:**
+
+```python
+tooltip.setTriangleSize(7)  # Default: 5
+```
+
+* **Setting a duration:**
+
+```python
+tooltip.setDuration(1000)  # Default: 0
+```
+
+> The duration is the time in milliseconds after which the tooltip will start fading out again.
+> If the duration is set to `0`, the tooltip will stay visible for as long as the widget is hovered.
+
+* **Adding delays to the fade in / out animations after hovering the widget:**
+
+```python
+tooltip.setShowDelay(500)  # Default: 50
+tooltip.setHideDelay(500)  # Default: 50
+```
+
+* **Setting the durations of the fade in / out animations:**
+
+```python
+tooltip.setFadeInDuration(250)   # Default: 150
+tooltip.setFadeOutDuration(250)  # Default: 150
+```
+
+* **Setting the refresh rate in Hz:**
+
+```python
+tooltip.setRefreshRate(30)  # Default: 60
+```
+
+* **Setting the border radius:**
+
+```python
+tooltip.setBorderRadius(0)   # Default: 8
+```
+
+* **Enabling or disabling the border:**
+
+```python
+tooltip.setBorderEnabled(False)   # Default: True
+```
+
+* **Setting custom colors:**
+
+```python
+tooltip.setBackgroundColor(QColor('#FCBA03'))   # Default: QColor('#FFFFFF')
+tooltip.setTextColor(QColor('#000000'))         # Default: QColor('#373737')
+tooltip.setBorderColor(QColor('#A38329'))       # Default: QColor('#CDCFD6')
+```
+
+* **Setting a custom font:**
+
+```python
+tooltip.setFont(QFont('Consolas', 10))  # Default: QFont('Arial', 9, QFont.Weight.Bold)
+```
+
+* **Applying margins to the content of the tooltip:**
+
+```python
+tooltip.setMargins(QMargins(10, 8, 10, 8))  # Default: QMargins(12, 8, 12, 7)
+```
+
+* **Setting a maximum width:**
+
+```python
+tooltip.setMaximumWidth(150)  # Default: 16777215 (QWIDGETSIZE_MAX)
+```
+
+* **Enabling or disabling text centering for wrapped text:**
+
+```python
+tooltip.setTextCenteringEnabled(False)  # Default: True
+```
+
+* **Enabling or disabling the drop shadow:**
+
+```python
+tooltip.setDropShadowEnabled(False)  # Default: True
+```
+
+* **Changing the drop shadow strength:**
+
+```python
+tooltip.setDropShadowStrength(3.5)  # Default: 2.0
+```
+
+* **Making the tooltip translucent:**
+
+```python
+tooltip.setOpacity(0.8)  # Default: 1.0
+```
+
+**<br>Other customization options:**
+
+| Option                      | Description                                                   | Default                    |
+|-----------------------------|---------------------------------------------------------------|----------------------------|
+| `setShowingOnDisabled()`    | Whether the tooltips should also be shown on disabled widgets | `False`                    |
+| `setFadeInEasingCurve()`    | The easing curve of the fade in animation                     | `QEasingCurve.Type.Linear` |
+| `setFadeOutEasingCurve()`   | The easing curve of the fade out animation                    | `QEasingCurve.Type.Linear` |
+| `setMarginLeft()`           | Set left margin individually                                  | `12`                       |
+| `setMarginRight()`          | Set right margin individually                                 | `12`                       |
+| `setMarginTop()`            | Set top margin individually                                   | `8`                        |
+| `setMarginBottom()`         | Set bottom margin individually                                | `7`                        |
+
+## Demo
+
+https://github.com/user-attachments/assets/04af0cfc-32fd-4aa7-80e6-6f263e44af67
+
+The demos for PyQt5, PyQt6, and PySide6 can be found in the [demo](https://github.com/FaBuLuZz/ztooltip/blob/master/demo) folder.
+
+> To keep the demo simple, only the most important features are included.
+> To get an overview of all the customization options, check out the documentation above.
+
+## Tests
+
+Installing the required test dependencies [PyQt6](https://pypi.org/project/PyQt6/), [pytest](https://github.com/pytest-dev/pytest), and [coveragepy](https://github.com/nedbat/coveragepy):
+
+```sh
+pip install PyQt6 pytest coverage
+```
+
+To run the tests with coverage, clone this repository, go into the main directory and run:
+
+```sh
+coverage run -m pytest
+coverage report --ignore-errors -m
+```
+
+## License
+
+This software is licensed under the [MIT license](https://github.com/FaBuLuZz/ZToolTip/blob/master/LICENSE).

ztooltip-2.0.0/README.md

@@ -0,0 +1,231 @@
+# ZToolTip
+
+[![PyPI](https://img.shields.io/badge/pypi-v2.0.0-blue)](https://pypi.org/project/ZToolTip/)
+[![Python](https://img.shields.io/badge/python-3.7+-blue)](https://github.com/FaBuLuZz/ZToolTip)
+[![Build](https://img.shields.io/badge/build-passing-neon)](https://github.com/FaBuLuZz/ZToolTip)
+[![Coverage](https://img.shields.io/badge/coverage-91%25-green)](https://github.com/FaBuLuZz/ZToolTip)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/FaBuLuZz/ZToolTip/blob/master/LICENSE)
+
+Forked from [pyqttooltip](https://github.com/niklashenning/pyqttooltip) by [Niklas Henning](https://github.com/niklashenning)
+
+A modern and fully customizable tooltip library for PyQt and PySide
+
+![ZToolTip](https://github.com/user-attachments/assets/0313ffc7-560b-4665-a652-e1e2601fcbaa)
+
+## Features
+
+- Fixed and automatic placement
+- Customizable triangle
+- Customizable animations and delays
+- Fully customizable and modern UI
+- Works with `PyQt5`, `PyQt6`, `PySide2`, and `PySide6`
+
+## Installation
+
+```sh
+pip install ztooltip
+```
+
+## Usage
+
+```python
+from PyQt6.QtWidgets import QMainWindow, QPushButton
+from ztooltip 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')
+```
+
+The tooltip will automatically be shown while hovering the widget. If you want to manually
+show and hide the tooltip, you can use the `show()` and `hide()` methods:
+
+```python
+tooltip.show()
+tooltip.hide()
+```
+
+To delete a tooltip, you can use the `deleteLater()` method:
+
+```python
+tooltip.deleteLater()
+```
+
+To get notified when a tooltip gets shown or hidden, you can subscribe to the `shown` and `hidden` signals:
+
+```python
+tooltip.shown.connect(lambda: print('shown'))
+tooltip.hidden.connect(lambda: print('hidden'))
+```
+
+## Customization
+
+* **Setting the widget:**
+
+```python
+tooltip.setWidget(widget)  # Default: None
+```
+
+* **Setting the text:**
+
+```python
+tooltip.setText('Text of the tooltip')  # Default: ''
+```
+
+* **Setting the placement:**
+
+```python
+tooltip.setPlacement(TooltipPlacement.RIGHT)  # Default: TooltipPlacement.AUTO
+```
+
+> **AVAILABLE PLACEMENTS:** <br> `AUTO`, `LEFT`, `RIGHT`, `TOP`, `BOTTOM`
+
+* **Enabling or disabling the triangle:**
+
+```python
+tooltip.setTriangleEnabled(False)  # Default: True
+```
+
+* **Setting the size of the triangle:**
+
+```python
+tooltip.setTriangleSize(7)  # Default: 5
+```
+
+* **Setting a duration:**
+
+```python
+tooltip.setDuration(1000)  # Default: 0
+```
+
+> The duration is the time in milliseconds after which the tooltip will start fading out again.
+> If the duration is set to `0`, the tooltip will stay visible for as long as the widget is hovered.
+
+* **Adding delays to the fade in / out animations after hovering the widget:**
+
+```python
+tooltip.setShowDelay(500)  # Default: 50
+tooltip.setHideDelay(500)  # Default: 50
+```
+
+* **Setting the durations of the fade in / out animations:**
+
+```python
+tooltip.setFadeInDuration(250)   # Default: 150
+tooltip.setFadeOutDuration(250)  # Default: 150
+```
+
+* **Setting the refresh rate in Hz:**
+
+```python
+tooltip.setRefreshRate(30)  # Default: 60
+```
+
+* **Setting the border radius:**
+
+```python
+tooltip.setBorderRadius(0)   # Default: 8
+```
+
+* **Enabling or disabling the border:**
+
+```python
+tooltip.setBorderEnabled(False)   # Default: True
+```
+
+* **Setting custom colors:**
+
+```python
+tooltip.setBackgroundColor(QColor('#FCBA03'))   # Default: QColor('#FFFFFF')
+tooltip.setTextColor(QColor('#000000'))         # Default: QColor('#373737')
+tooltip.setBorderColor(QColor('#A38329'))       # Default: QColor('#CDCFD6')
+```
+
+* **Setting a custom font:**
+
+```python
+tooltip.setFont(QFont('Consolas', 10))  # Default: QFont('Arial', 9, QFont.Weight.Bold)
+```
+
+* **Applying margins to the content of the tooltip:**
+
+```python
+tooltip.setMargins(QMargins(10, 8, 10, 8))  # Default: QMargins(12, 8, 12, 7)
+```
+
+* **Setting a maximum width:**
+
+```python
+tooltip.setMaximumWidth(150)  # Default: 16777215 (QWIDGETSIZE_MAX)
+```
+
+* **Enabling or disabling text centering for wrapped text:**
+
+```python
+tooltip.setTextCenteringEnabled(False)  # Default: True
+```
+
+* **Enabling or disabling the drop shadow:**
+
+```python
+tooltip.setDropShadowEnabled(False)  # Default: True
+```
+
+* **Changing the drop shadow strength:**
+
+```python
+tooltip.setDropShadowStrength(3.5)  # Default: 2.0
+```
+
+* **Making the tooltip translucent:**
+
+```python
+tooltip.setOpacity(0.8)  # Default: 1.0
+```
+
+**<br>Other customization options:**
+
+| Option                      | Description                                                   | Default                    |
+|-----------------------------|---------------------------------------------------------------|----------------------------|
+| `setShowingOnDisabled()`    | Whether the tooltips should also be shown on disabled widgets | `False`                    |
+| `setFadeInEasingCurve()`    | The easing curve of the fade in animation                     | `QEasingCurve.Type.Linear` |
+| `setFadeOutEasingCurve()`   | The easing curve of the fade out animation                    | `QEasingCurve.Type.Linear` |
+| `setMarginLeft()`           | Set left margin individually                                  | `12`                       |
+| `setMarginRight()`          | Set right margin individually                                 | `12`                       |
+| `setMarginTop()`            | Set top margin individually                                   | `8`                        |
+| `setMarginBottom()`         | Set bottom margin individually                                | `7`                        |
+
+## Demo
+
+https://github.com/user-attachments/assets/04af0cfc-32fd-4aa7-80e6-6f263e44af67
+
+The demos for PyQt5, PyQt6, and PySide6 can be found in the [demo](https://github.com/FaBuLuZz/ztooltip/blob/master/demo) folder.
+
+> To keep the demo simple, only the most important features are included.
+> To get an overview of all the customization options, check out the documentation above.
+
+## Tests
+
+Installing the required test dependencies [PyQt6](https://pypi.org/project/PyQt6/), [pytest](https://github.com/pytest-dev/pytest), and [coveragepy](https://github.com/nedbat/coveragepy):
+
+```sh
+pip install PyQt6 pytest coverage
+```
+
+To run the tests with coverage, clone this repository, go into the main directory and run:
+
+```sh
+coverage run -m pytest
+coverage report --ignore-errors -m
+```
+
+## License
+
+This software is licensed under the [MIT license](https://github.com/FaBuLuZz/ZToolTip/blob/master/LICENSE).

ztooltip-2.0.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ZToolTip"
+version = "2.0.0"
+description = "A modern and fully customizable tooltip library for PyQt and PySide"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "FaBuLuZz"}
+]
+keywords = ["python", "qt", "pyqt", "pyside", "tooltip", "modern"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: MIT License"
+]
+requires-python = ">=3.7"
+dependencies = [
+    "pywin32>=311",
+    "QtPy>=2.4.1"
+]
+
+[project.urls]
+Homepage = "https://github.com/FaBuLuZz/ZToolTip"
+
+[tool.setuptools.packages.find]
+where = ["src"]

ztooltip-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+