Improved LED functionality, see slightlynybbled#30. Making some variables private

slightlynybbled · slightlynybbled · commit e0042190d34c · 2018-05-04T07:58:58.000-04:00
diff --git a/examples/leds.py b/examples/leds.py
@@ -2,31 +2,44 @@
 import tk_tools
 
 
+def on_click_callback(on):
+    if on:
+        print('led is on')
+    else:
+        print('led is off')
+
+
 if __name__ == '__main__':
 
     root = tk.Tk()
 
-    led = tk_tools.Led(root, size=50)
-    led.pack()
+    led0 = tk_tools.Led(root, size=50, on_click_callback=on_click_callback)
+    led0.pack()
 
-    tk.Button(root, text='red', command=led.to_red).pack(fill=tk.X)
+    tk.Button(root, text='red', command=led0.to_red).pack(fill=tk.X)
 
     tk.Button(root,
               text='red on',
-              command=lambda: led.to_red(True)).pack(fill=tk.X)
+              command=lambda: led0.to_red(True)).pack(fill=tk.X)
 
-    tk.Button(root, text='green', command=led.to_green).pack(fill=tk.X)
+    tk.Button(root, text='green', command=led0.to_green).pack(fill=tk.X)
 
     tk.Button(root,
               text='green on',
-              command=lambda: led.to_green(True)).pack(fill=tk.X)
+              command=lambda: led0.to_green(True)).pack(fill=tk.X)
 
-    tk.Button(root, text='yellow', command=led.to_yellow).pack(fill=tk.X)
+    tk.Button(root, text='yellow', command=led0.to_yellow).pack(fill=tk.X)
 
     tk.Button(root,
               text='yellow on',
-              command=lambda: led.to_yellow(True)).pack(fill=tk.X)
+              command=lambda: led0.to_yellow(True)).pack(fill=tk.X)
+
+    tk.Button(root, text='grey', command=led0.to_grey).pack(fill=tk.X)
+
+    tk.Label(root, text='Clickable LED').pack(fill=tk.X)
 
-    tk.Button(root, text='grey', command=led.to_grey).pack(fill=tk.X)
+    led1 = tk_tools.Led(root, size=50, on_click_callback=on_click_callback, toggle_on_click=True)
+    led1.to_green()
+    led1.pack()
 
     root.mainloop()
diff --git a/tk_tools/canvas.py b/tk_tools/canvas.py
@@ -459,7 +459,7 @@ def frange(start, stop, step, digits_to_round=3):
             start += step
 
 
-class Led(tk.Frame):
+class Led(ttk.Frame):
     """
     Create an LED-like interface for the user.::
 
@@ -469,41 +469,62 @@ class Led(tk.Frame):
         led.to_red()
         led.to_green(on=True)
 
+    The user also has the option of adding an `on_click_callback`
+    function.  When the button is clicked, the button will change
+    state and the on-click callback will be executed.  The
+    callback must accept a single boolean parameter, `on`, which
+    indicates if the LED was just turned on or off.
+
     :param parent: the parent frame
     :param size: the size in pixels
+    :param on_click_callback: a callback which accepts a boolean parameter 'on'
     :param options: the frame options
     """
-    def __init__(self, parent, size=100, **options):
+    def __init__(self, parent, size=100, on_click_callback=None, toggle_on_click=False, **options):
         self._parent = parent
-        super().__init__(self._parent, padx=3, pady=3, borderwidth=2,
+        super().__init__(self._parent, padding=3, borderwidth=2,
                          **options)
 
-        self.size = size
+        self._size = size
 
-        self.canvas = tk.Canvas(self, width=self.size, height=self.size)
-        self.canvas.grid(row=0)
-        self.image = None
+        self._canvas = tk.Canvas(self, width=self._size, height=self._size)
+        self._canvas.grid(row=0)
+        self._image = None
+        self._on = False
+        self._user_click_callback = on_click_callback
+        self._toggle_on_click = toggle_on_click
 
         self.to_grey()
 
+        def on_click(e):
+            if self._user_click_callback is not None:
+                self._user_click_callback(self._on)
+
+        self._canvas.bind('<Button-1>', on_click)
+
     def _load_new(self, img_data: str):
         """
         Load a new image.
 
         :param img_data: the image data as a base64 string
         :return: None
         """
-        self.image = tk.PhotoImage(data=img_data)
-        self.image = self.image.subsample(int(200 / self.size),
-                                          int(200 / self.size))
-        self.canvas.create_image(0, 0, image=self.image, anchor='nw')
+        self._image = tk.PhotoImage(data=img_data)
+        self._image = self._image.subsample(int(200 / self._size),
+                                            int(200 / self._size))
+        self._canvas.create_image(0, 0, image=self._image, anchor='nw')
 
-    def to_grey(self):
+        if self._user_click_callback is not None:
+            self._user_click_callback(self._on)
+
+    def to_grey(self, on: bool=False):
         """
         Change the LED to grey.
 
+        :param on: Unused, here for API consistency with the other states
         :return: None
         """
+        self._on = False
         self._load_new(led_grey)
 
     def to_green(self, on: bool=False):
@@ -513,17 +534,25 @@ def to_green(self, on: bool=False):
         :param on: True or False
         :return: None
         """
+        self._on = on
         if on:
             self._load_new(led_green_on)
+
+            if self._toggle_on_click:
+                self._canvas.bind('<Button-1>', lambda x: self.to_green(False))
         else:
             self._load_new(led_green)
 
+            if self._toggle_on_click:
+                self._canvas.bind('<Button-1>', lambda x: self.to_green(True))
+
     def to_red(self, on: bool=False):
         """
         Change the LED to red (on or off)
         :param on: True or False
         :return: None
         """
+        self._on = on
         if on:
             self._load_new(led_red_on)
         else:
@@ -535,6 +564,7 @@ def to_yellow(self, on: bool=False):
         :param on: True or False
         :return: None
         """
+        self._on = on
         if on:
             self._load_new(led_yellow_on)
         else:
diff --git a/tk_tools/groups.py b/tk_tools/groups.py
@@ -615,7 +615,7 @@ def __init__(self, parent, callback=None, **kwargs):
         self.__setup_styles()       # creates custom styles
         self.__place_widgets()      # pack/grid used widgets
         self.__config_calendar()    # adjust calendar columns and setup tags
-        # configure a canvas, and proper bindings, for selecting dates
+        # configure a _canvas, and proper bindings, for selecting dates
         self.__setup_selection(sel_bg, sel_fg)
 
         # store items ids, used for insertion later
diff --git a/tk_tools/version.py b/tk_tools/version.py
@@ -1 +1 @@
-__version__ = '0.8.2'
+__version__ = '0.9.0'

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.8.2'`
	`1`	`+__version__ = '0.9.0'`