Add visible() function and isVisible property for controls

alankilborn · alankilborn · commit 5c30c4fa25c8 · 2023-10-29T06:25:51.000-04:00
diff --git a/helper/WinDialog/controls/__control_template.py b/helper/WinDialog/controls/__control_template.py
@@ -2,7 +2,8 @@
 from ctypes.wintypes import DWORD, WORD, SHORT
 from ..win_helper import (
     WindowStyle as WS,
-    EnableWindow, IsWindowEnabled
+    EnableWindow, IsWindowEnabled,
+    ShowWindow, ShowWindowCommands as SWC, IsWindowVisible,
 )
 
 from dataclasses import dataclass, field
@@ -29,6 +30,8 @@ class Control:
         registeredNotifications (Dict): A dictionary of registered notification messages and their associated handlers.
         isEnabled (bool): Indicates the state of the control.
             Returns True if the control is enabled, False otherwise
+        isVisible (bool): Indicates the visible state of the control.
+            Returns True if the control is visible, False otherwise
 
     Methods:
         create(self) -> bytearray:
@@ -37,6 +40,9 @@ class Control:
         enable(self, state: bool) -> None:
             Enables or disables a control.
 
+        visible(self, state: bool) -> None:
+            Makes a control visible or invisible.
+
 
     Note:
         Do not instantiate this class directly. It should be subclassed by specific controls.
@@ -101,3 +107,23 @@ def enable(self, state: bool):
     def isEnabled(self) -> bool :
         return bool(IsWindowEnabled(self.hwnd))
 
+    def visible(self, state: bool):
+        '''
+        Makes a control visible or invisible.
+
+        Args:
+            state (bool): Indicates whether to make the window visible or invisible.
+                If this parameter is True, the window will be made visible (shown).
+                If the parameter is False, the window will be made invisible (hidden).
+
+        Returns:
+            None
+
+        '''
+        ShowWindow(self.hwnd, SWC.SHOW if state else SWC.HIDE)
+        return self.isVisible
+
+    @property
+    def isVisible(self) -> bool :
+        return bool(IsWindowVisible(self.hwnd))
+
diff --git a/helper/WinDialog/win_helper/__init__.py b/helper/WinDialog/win_helper/__init__.py
@@ -180,6 +180,10 @@
 IsWindowEnabled.restype = BOOL
 IsWindowEnabled.argtypes = [HWND]
 
+IsWindowVisible = user32.IsWindowVisible
+IsWindowVisible.restype = BOOL
+IsWindowVisible.argtypes = [HWND]
+
 class SWP(IntEnum):
     NOSIZE          = 0x0001  #
     NOMOVE          = 0x0002  #
@@ -591,4 +595,4 @@ class WINDOWPOS(Structure):
         ("cy", INT),
         ("flags", UINT),
     ]
-LPWINDOWPOS = POINTER(WINDOWPOS)
+LPWINDOWPOS = POINTER(WINDOWPOS)
