batframework 1.0.9a7__py3-none-any.whl → 1.0.9a9__py3-none-any.whl

batFramework/gui/clickableWidget.py

@@ -1,10 +1,8 @@
-from .label import Label
 import batFramework as bf
 from typing import Self, Callable, Any
 from .interactiveWidget import InteractiveWidget
 from .shape import Shape
 import pygame
-from math import ceil
 
 
 class ClickableWidget(Shape, InteractiveWidget):
@@ -13,31 +11,27 @@ class ClickableWidget(Shape, InteractiveWidget):
     def __init__(self, callback: Callable[[],Any] = None, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.callback = callback
-        self.is_pressed: bool = False
-        self.enabled: bool = True
+        self.is_pressed: bool = False # the state where the button is being held down (releasing will trigger callback)
+        self.is_enabled: bool = True # 
         self.hover_cursor = bf.const.DEFAULT_HOVER_CURSOR
         self.click_cursor = bf.const.DEFAULT_CLICK_CURSOR
+
         self.click_down_sound = None
         self.click_up_sound = None
         self.get_focus_sound = None
         self.lose_focus_sound = None
-        self.pressed_relief: int = 1
-        self.unpressed_relief: int = 2
+
+        self.pressed_relief: int = 1    # Depth effect height when pressed
+        self.unpressed_relief: int = 2  # Depth effect height when released (default)
         self.silent_focus: bool = False
         self.set_debug_color("cyan")
         self.set_relief(self.unpressed_relief)
 
+
     def get_min_required_size(self) -> tuple[float, float]:
-        if not (self.autoresize_w or self.autoresize_h):
-            return self.rect.size
-        
         res = super().get_min_required_size()
         res = res[0],res[1]+self.unpressed_relief
-        print("hey",res)
-        return res[0] if self.autoresize_w else self.rect.w, (
-            res[1] if self.autoresize_h else self.rect.h
-        )
-
+        return res
 
     def set_unpressed_relief(self, relief: int) -> Self:
         if relief == self.unpressed_relief:
@@ -106,18 +100,15 @@ class ClickableWidget(Shape, InteractiveWidget):
         return True
 
     def enable(self) -> Self:
-        self.enabled = True
+        self.is_enabled = True
         self.dirty_surface = True
         return self
 
     def disable(self) -> Self:
-        self.enabled = False
+        self.is_enabled = False
         self.dirty_surface = True
         return self
 
-    def is_enabled(self) -> bool:
-        return self.enabled
-
     def set_callback(self, callback: Callable[[],Any]) -> Self:
         self.callback = callback
         return self
@@ -142,31 +133,56 @@ class ClickableWidget(Shape, InteractiveWidget):
         return f"ClickableWidget"
 
     def click(self, force=False) -> None:
-        if not self.enabled and not force:
-            return
+        if not self.is_enabled and not force:
+            return False
         if self.callback is not None:
             self.callback()
+            return True
+        return False
+
+    def on_key_down(self, key):
+        if key == pygame.K_SPACE:
+            self.on_click_down(1)
+            return True
+        return self.do_on_key_down(key)
+    
+    def on_key_up(self, key):
+        if key == pygame.K_SPACE:
+            self.on_click_up(1)
+            return True
+        return self.do_on_key_down(key)
+        
 
-    def do_on_click_down(self, button) -> None:
-        if self.enabled and button == 1:
-            if not self.get_focus():
-                return
-            self.is_pressed = True
-            if self.click_down_sound:
-                bf.AudioManager().play_sound(self.click_down_sound)
-            pygame.mouse.set_cursor(self.click_cursor)
-            self.set_relief(self.pressed_relief)
-
-    def do_on_click_up(self, button) -> None:
-        if self.enabled and button == 1 and self.is_pressed:
+    def on_click_down(self, button) -> bool:
+        if button < 1 or button > 5 : return False
+        self.is_clicked_down[button-1] = True
+        if self.is_enabled and button == 1:
+            if self.get_focus():
+                self.is_pressed = True
+                if self.click_down_sound:
+                    bf.AudioManager().play_sound(self.click_down_sound)
+                pygame.mouse.set_cursor(self.click_cursor)
+                self.set_relief(self.pressed_relief)
+                self.do_on_click_down(button)
+            return True
+        return False
+
+    def on_click_up(self, button):
+        if button < 1 or button > 5 : return False
+        self.is_clicked_down[button-1] = False
+        if self.is_enabled and button == 1 and self.is_pressed:
             self.is_pressed = False
             if self.click_up_sound:
                 bf.AudioManager().play_sound(self.click_up_sound)
             self.set_relief(self.unpressed_relief)
             self.click()
+            self.do_on_click_up(button)
+            return True
+        return False
+
 
     def on_enter(self) -> None:
-        if not self.enabled:
+        if not self.is_enabled:
             return
         super().on_enter()
         self.dirty_surface = True
@@ -178,22 +194,12 @@ class ClickableWidget(Shape, InteractiveWidget):
             self.set_relief(self.unpressed_relief)
         self.is_pressed = False
         self.dirty_surface = True
-
         pygame.mouse.set_cursor(bf.const.DEFAULT_CURSOR)
 
     def on_lose_focus(self):
         super().on_lose_focus()
         self.on_exit()
 
-    def on_key_down(self, key):
-        if key == pygame.K_SPACE:
-            self.on_click_down(1)
-        super().on_key_down(key)
-
-    def on_key_up(self, key):
-        if key == pygame.K_SPACE:
-            self.on_click_up(1)
-        super().on_key_up(key)
 
     def _paint_disabled(self) -> None:
         self.surface.blit(
@@ -205,16 +211,23 @@ class ClickableWidget(Shape, InteractiveWidget):
             self.get_surface_filter(), (0, 0), special_flags=pygame.BLEND_RGB_ADD
         )
 
-    def get_padded_rect(self) -> pygame.FRect:
+    def get_inner_rect(self) -> pygame.FRect:
         return pygame.FRect(
             self.rect.x + self.padding[0],
-            self.rect.y
-            + self.padding[1]
-            + (self.unpressed_relief - self.pressed_relief if self.is_pressed else 0),
+            self.rect.y + self.padding[1] + (self.unpressed_relief - self.pressed_relief if self.is_pressed else 0),
             self.rect.w - self.padding[2] - self.padding[0],
-            self.rect.h - self.unpressed_relief - self.padding[1] - self.padding[3],  #
+            self.rect.h - self.unpressed_relief - self.padding[1] - self.padding[3],
         )
 
+    def get_local_inner_rect(self) -> pygame.FRect:
+        return pygame.FRect(
+            self.padding[0],
+            self.padding[1] + (self.unpressed_relief - self.pressed_relief if self.is_pressed else 0),
+            self.rect.w - self.padding[2] - self.padding[0],
+            self.rect.h - self.unpressed_relief - self.padding[1] - self.padding[3],
+        )
+
+
     def _get_elevated_rect(self) -> pygame.FRect:
         return pygame.FRect(
             0,
@@ -225,7 +238,7 @@ class ClickableWidget(Shape, InteractiveWidget):
 
     def paint(self) -> None:
         super().paint()
-        if not self.enabled:
+        if not self.is_enabled:
             self._paint_disabled()
         elif self.is_hovered:
             self._paint_hovered()