implement custom tray tip text

Author: spyoungtech

ahk/_async/engine.py

@@ -1367,6 +1367,18 @@ async def show_tooltip(
     async def hide_tooltip(self, which: int = 1) -> None:
         await self.show_tooltip(which=which)
 
+    async def menu_tray_tooltip(self, value: str) -> None:
+        """
+        Change the menu tray icon tooltip that appears when hovering the mouse over the tray icon.
+        Does not affect tray icon for AHK processes started with :py:meth:`run_script` or ``blocking=False``
+
+        Uses the `Tip subcommand <https://www.autohotkey.com/docs/v1/lib/Menu.htm#Tip>`_
+        """
+
+        args = [value]
+        await self._transport.function_call('AHKMenuTrayTip', args)
+        return None
+
     # fmt: off
     @overload
     async def sound_beep(self, frequency: int = 523, duration: int = 150) -> None: ...

ahk/_async/transport.py

@@ -95,6 +95,7 @@ def result(self, timeout: Optional[float] = None) -> T_SyncFuture:
     'AHKImageSearch',
     'AHKKeyState',
     'AHKKeyWait',
+    'AHKMenuTrayTip',
     'AHKMouseClickDrag',
     'AHKMouseGetPos',
     'AHKMouseMove',
@@ -565,7 +566,8 @@ async def function_call(self, function_name: Literal['AHKRegRead'], args: Option
     async def function_call(self, function_name: Literal['AHKRegWrite'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, AsyncFutureResult[None]]: ...
     @overload
     async def function_call(self, function_name: Literal['AHKRegDelete'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, AsyncFutureResult[None]]: ...
-
+    @overload
+    async def function_call(self, function_name: Literal['AHKMenuTrayTip'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, AsyncFutureResult[None]]: ...
     # fmt: on
 
     async def function_call(

ahk/_constants.py

@@ -2603,6 +2603,12 @@
     return FormatNoValueResponse()
 }
 
+AHKMenuTrayTip(ByRef command) {
+    value := command[2]
+    Menu, Tray, Tip, %value%
+    return FormatNoValueResponse()
+}
+
 b64decode(ByRef pszString) {
     ; TODO load DLL globally for performance
     ; REF: https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-cryptstringtobinaryw

ahk/_sync/engine.py

@@ -1356,6 +1356,18 @@ def show_tooltip(
     def hide_tooltip(self, which: int = 1) -> None:
         self.show_tooltip(which=which)
 
+    def menu_tray_tooltip(self, value: str) -> None:
+        """
+        Change the menu tray icon tooltip that appears when hovering the mouse over the tray icon.
+        Does not affect tray icon for AHK processes started with :py:meth:`run_script` or ``blocking=False``
+
+        Uses the `Tip subcommand <https://www.autohotkey.com/docs/v1/lib/Menu.htm#Tip>`_
+        """
+
+        args = [value]
+        self._transport.function_call('AHKMenuTrayTip', args)
+        return None
+
     # fmt: off
     @overload
     def sound_beep(self, frequency: int = 523, duration: int = 150) -> None: ...

ahk/_sync/transport.py

@@ -87,6 +87,7 @@ def result(self, timeout: Optional[float] = None) -> T_SyncFuture:
     'AHKImageSearch',
     'AHKKeyState',
     'AHKKeyWait',
+    'AHKMenuTrayTip',
     'AHKMouseClickDrag',
     'AHKMouseGetPos',
     'AHKMouseMove',
@@ -546,7 +547,8 @@ def function_call(self, function_name: Literal['AHKRegRead'], args: Optional[Lis
     def function_call(self, function_name: Literal['AHKRegWrite'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, FutureResult[None]]: ...
     @overload
     def function_call(self, function_name: Literal['AHKRegDelete'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, FutureResult[None]]: ...
-
+    @overload
+    def function_call(self, function_name: Literal['AHKMenuTrayTip'], args: Optional[List[str]] = None, *, blocking: bool = True) -> Union[None, FutureResult[None]]: ...
     # fmt: on
 
     def function_call(

ahk/templates/daemon.ahk

@@ -2600,6 +2600,12 @@ AHKBlockInput(ByRef command) {
     return FormatNoValueResponse()
 }
 
+AHKMenuTrayTip(ByRef command) {
+    value := command[2]
+    Menu, Tray, Tip, %value%
+    return FormatNoValueResponse()
+}
+
 b64decode(ByRef pszString) {
     ; TODO load DLL globally for performance
     ; REF: https://docs.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-cryptstringtobinaryw