Rename Balloon widget to Tooltip

Author: dogeek

AUTHORS.md

@@ -8,7 +8,7 @@ This file contains a list of all the authors of widgets in this repository. Plea
   * `ScrolledListbox`
   * `FontChooser`, based on an idea by [Nelson Brochado](https://www.github.com/nbro)
   * `FontSelectFrame`
-  * `Balloon`
+  * `Tooltip`
   * `ItemsCanvas`
   * `TimeLine`
 - The Python Team

docs/source/authors.rst

@@ -11,7 +11,7 @@ List of all the authors of widgets in this repository. Please note that this lis
   * :class:`~ttkwidgets.ScrolledListbox`
   * :class:`~ttkwidgets.font.FontChooser`, based on an idea by `Nelson Brochado <https://www.github.com/nbro>`_
   * :class:`~ttkwidgets.font.FontSelectFrame`
-  * :class:`~ttkwidgets.frames.Balloon`
+  * :class:`~ttkwidgets.frames.Tooltip`
   * :class:`~ttkwidgets.ItemsCanvas`
   * :class:`~ttkwidgets.TimeLine`
 

docs/source/ttkwidgets/ttkwidgets.frames.rst

@@ -11,6 +11,6 @@ ttkwidgets.frames
     :nosignatures:
     :toctree: ttkwidgets.frames
 
-    Balloon
+    Tooltip
     ScrolledFrame
     ToggledFrame

docs/source/ttkwidgets/ttkwidgets.frames/ttkwidgets.frames.Balloon.rst

@@ -1,9 +1,9 @@
-Balloon
+Tooltip
 =======
 
 .. currentmodule:: ttkwidgets.frames
 
-.. autoclass:: Balloon
+.. autoclass:: Tooltip
    :show-inheritance:
    :members:
 

examples/example_balloon.py examples/example_tooltip.pyexamples/example_balloon.py renamed to examples/example_tooltip.py

@@ -2,17 +2,13 @@
 
 # Copyright (c) RedFantom 2017
 # For license see LICENSE
-from ttkwidgets.frames import Balloon
-try:
-    import Tkinter as tk
-    import ttk
-except ImportError:
-    import tkinter as tk
-    from tkinter import ttk
+from ttkwidgets import Tooltip
+import tkinter as tk
+from tkinter import ttk
 
 
 window = tk.Tk()
 button = tk.Button(window, text="Button", command=window.destroy)
 button.pack()
-balloon = Balloon(button)
+balloon = Tooltip(button)
 window.mainloop()

tests/test_balloon.py

@@ -3,7 +3,7 @@
 License: GNU GPLv3
 Source: This repository
 """
-from ttkwidgets.frames import Balloon
+from ttkwidgets.frames import Tooltip
 from ttkwidgets.utilities import parse_geometry_string
 from tests import BaseWidgetTest
 try:
@@ -13,24 +13,24 @@
 from time import sleep
 
 
-class TestBalloon(BaseWidgetTest):
+class TestTooltip(BaseWidgetTest):
     def test_balloon_init(self):
-        balloon = Balloon(self.window)
+        balloon = Tooltip(self.window)
         self.window.update()
 
     def test_balloon_kwargs(self):
-        balloon = Balloon(self.window, headertext="Help", text="This is a test for the Balloon widget.", width=300,
+        balloon = Tooltip(self.window, headertext="Help", text="This is a test for the Tooltip widget.", width=300,
                           timeout=2, background="white", showheader=True, offset=(20, 20), static=True)
         self.assertEqual(balloon.cget("headertext"), "Help")
-        self.assertEqual(balloon.cget("text"), "This is a test for the Balloon widget.")
+        self.assertEqual(balloon.cget("text"), "This is a test for the Tooltip widget.")
         self.assertEqual(balloon.cget("width"), 300)
         self.assertEqual(balloon.cget("timeout"), 2)
         self.assertEqual(balloon.cget("background"), "white")
 
-        balloon.config(headertext="New Help", text="This is another test for the Balloon widget.", width=400,
+        balloon.config(headertext="New Help", text="This is another test for the Tooltip widget.", width=400,
                        timeout=3, background="black")
         self.assertEqual(balloon["headertext"], "New Help")
-        self.assertEqual(balloon["text"], "This is another test for the Balloon widget.")
+        self.assertEqual(balloon["text"], "This is another test for the Tooltip widget.")
         self.assertEqual(balloon["width"], 400)
         self.assertEqual(balloon["timeout"], 3)
         self.assertEqual(balloon["background"], "black")
@@ -70,7 +70,7 @@ def test_balloon_kwargs(self):
         self.assertFalse(x2 == x3 or y2 == y3)
 
     def test_balloon_show(self):
-        balloon = Balloon(self.window)
+        balloon = Tooltip(self.window)
         self.window.update()
         balloon.show()
         self.window.update()
@@ -82,7 +82,7 @@ def test_balloon_show(self):
         self.assertIs(balloon._toplevel, None)
 
     def test_balloon_events(self):
-        balloon = Balloon(self.window, timeout=0.2)
+        balloon = Tooltip(self.window, timeout=0.2)
         balloon._on_enter(None)
         self.window.update()
         sleep(0.3)
@@ -92,6 +92,6 @@ def test_balloon_events(self):
         self.assertIs(balloon._toplevel, None)
 
     def test_balloon_events_noshow(self):
-        balloon = Balloon(self.window)
+        balloon = Tooltip(self.window)
         balloon._on_enter(None)
         balloon._on_leave(None)

ttkwidgets/frames/__init__.py

@@ -2,4 +2,4 @@
 # Available under the license found in LICENSE
 from .scrolledframe import ScrolledFrame
 from .toggledframe import ToggledFrame
-from .balloon import Balloon
+from .tooltip import Tooltip

ttkwidgets/frames/balloon.py ttkwidgets/frames/tooltip.pyttkwidgets/frames/balloon.py renamed to ttkwidgets/frames/tooltip.py

@@ -14,25 +14,25 @@
 from ttkwidgets.utilities import get_assets_directory
 
 
-class Balloon(ttk.Frame):
+class Tooltip(ttk.Frame):
     """Simple help hover balloon."""
 
     def __init__(self, master=None, headertext="Help", text="Some great help is displayed here.", width=200, timeout=1,
                  background="#fef9cd", offset=(2, 2), showheader=True, static=False, **kwargs):
         """
-        Create a Balloon
+        Create a Tooltip
         
-        :param master: widget to bind the Balloon to
+        :param master: widget to bind the Tooltip to
         :type master: widget
         :param headertext: text to show in window header
         :type headertext: str
         :param text: text to show as help text
         :type text: str
         :param width: width of the window
         :type width: int
-        :param timeout: timeout in seconds to wait until the Balloon is shown
+        :param timeout: timeout in seconds to wait until the Tooltip is shown
         :type timeout: float
-        :param background: background color of the Balloon
+        :param background: background color of the Tooltip
         :type background: str
         :param offset: The offset from the mouse position the Ballon shows up
         :type offset: Tuple[int, int]
@@ -102,7 +102,7 @@ def show(self):
         Create the Toplevel and its children to show near the cursor
 
         This is the callback for the delayed :obj:`<Enter>` event
-        (see :meth:`~Balloon._on_enter`).
+        (see :meth:`~Tooltip._on_enter`).
         """
         self._toplevel = tk.Toplevel(self.master)
         self._canvas = tk.Canvas(self._toplevel, background=self.__background)
@@ -134,7 +134,7 @@ def cget(self, key):
         :return: value of the option
 
         To get the list of options for this widget, call the method
-        :meth:`~Balloon.keys`.
+        :meth:`~Tooltip.keys`.
         """
         if key == "headertext":
             return self.__headertext
@@ -160,7 +160,7 @@ def config(self, **kwargs):
         Configure resources of the widget.
 
         To get the list of options for this widget, call the method
-        :meth:`~Balloon.keys`. See :meth:`~Balloon.__init__` for a
+        :meth:`~Tooltip.keys`. See :meth:`~Tooltip.__init__` for a
         description of the widget specific option.
         """
         self.__headertext = kwargs.pop("headertext", self.__headertext)