feat: add useful method for tray

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0
+
+* [Feature] add some helper functions (setImage / setTooltip / setTitle / getTitle)
+* [Fixed] enable change icon image on macOS
+
 ## 0.0.9
 
 * [Feature] add popUpContextMenu

README.md

@@ -9,7 +9,7 @@ In the pubspec.yaml of your flutter project, add the following dependency:
 ```yaml
 dependencies:
   ...
-  system_tray: ^0.0.9
+  system_tray: ^0.1.0
 ```
 
 In your library add the following import:
@@ -77,6 +77,27 @@ sudo apt-get install appindicator3-0.1 libappindicator3-dev
           </ul>
         </td>
     </tr>
+    <tr>
+        <td>setImage</td>
+        <td>Modify the tray image</td>
+        <td>✔️</td>
+        <td>✔️</td>
+        <td>✔️</td>
+    </tr>
+    <tr>
+        <td>setTooltip</td>
+        <td>Modify the tray tooltip</td>
+        <td>✔️</td>
+        <td>✔️</td>
+        <td>➖</td>
+    </tr>
+    <tr>
+        <td>setTitle / getTitle</td>
+        <td>Set / Get the tray title</td>
+        <td>➖</td>
+        <td>✔️</td>
+        <td>➖</td>
+    </tr>
     <tr>
         <td>setContextMenu</td>
         <td>Set the tray context menu</td>
@@ -116,7 +137,6 @@ sudo apt-get install appindicator3-0.1 libappindicator3-dev
 </table>
 
 ## Usage
-Smallest example:
 
 ```dart
 Future<void> initSystemTray() async {
@@ -151,116 +171,6 @@ Future<void> initSystemTray() async {
 }
 ```
 
-Flashing icon example:
-
-```dart
-Future<void> initSystemTray() async {
-  String path =
-      Platform.isWindows ? 'assets/app_icon.ico' : 'assets/app_icon.png';
-
-  final menu = [
-    MenuItem(label: 'Show', onClicked: _appWindow.show),
-    MenuItem(label: 'Hide', onClicked: _appWindow.hide),
-    MenuItem(
-      label: 'Start flash tray icon',
-      onClicked: () {
-        debugPrint("Start flash tray icon");
-
-        _timer ??= Timer.periodic(
-          const Duration(milliseconds: 500),
-          (timer) {
-            _toogleTrayIcon = !_toogleTrayIcon;
-            _systemTray.setSystemTrayInfo(
-              iconPath: _toogleTrayIcon ? "" : path,
-            );
-          },
-        );
-      },
-    ),
-    MenuItem(
-      label: 'Stop flash tray icon',
-      onClicked: () {
-        debugPrint("Stop flash tray icon");
-
-        _timer?.cancel();
-        _timer = null;
-
-        _systemTray.setSystemTrayInfo(
-          iconPath: path,
-        );
-      },
-    ),
-    MenuSeparator(),
-    SubMenu(
-      label: "Test API",
-      children: [
-        SubMenu(
-          label: "setSystemTrayInfo",
-          children: [
-            MenuItem(
-              label: 'set title',
-              onClicked: () {
-                final String text = WordPair.random().asPascalCase;
-                debugPrint("click 'set title' : $text");
-                _systemTray.setSystemTrayInfo(
-                  title: text,
-                );
-              },
-            ),
-            MenuItem(
-              label: 'set icon path',
-              onClicked: () {
-                debugPrint("click 'set icon path' : $path");
-                _systemTray.setSystemTrayInfo(
-                  iconPath: path,
-                );
-              },
-            ),
-            MenuItem(
-              label: 'set tooltip',
-              onClicked: () {
-                final String text = WordPair.random().asPascalCase;
-                debugPrint("click 'set tooltip' : $text");
-                _systemTray.setSystemTrayInfo(
-                  toolTip: text,
-                );
-              },
-            ),
-          ],
-        ),
-        MenuItem(label: 'disabled Item', enabled: false),
-      ],
-    ),
-    MenuSeparator(),
-    MenuItem(
-      label: 'Exit',
-      onClicked: _appWindow.close,
-    ),
-  ];
-
-  // We first init the systray menu and then add the menu entries
-  await _systemTray.initSystemTray(
-    title: "system tray",
-    iconPath: path,
-    toolTip: "How to use system tray with Flutter",
-  );
-
-  await _systemTray.setContextMenu(menu);
-
-  // handle system tray event
-  _systemTray.registerSystemTrayEventHandler((eventName) {
-    debugPrint("eventName: $eventName");
-    if (eventName == "leftMouseDown") {
-    } else if (eventName == "leftMouseUp") {
-      _systemTray.popUpContextMenu();
-    } else if (eventName == "rightMouseDown") {
-    } else if (eventName == "rightMouseUp") {
-      _appWindow.show();
-    }
-  });
-}
-```
-
 # Addition
 
 Recommended library that supports window control:

example/lib/main.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 import 'dart:io';
+import 'dart:math';
 
 import 'package:bitsdojo_window/bitsdojo_window.dart';
 import 'package:english_words/english_words.dart';
@@ -51,6 +52,8 @@ class _MyAppState extends State<MyApp> {
     String path =
         Platform.isWindows ? 'assets/app_icon.ico' : 'assets/app_icon.png';
 
+    List<String> iconList = ['darts_icon', 'gift_icon'];
+
     final menu = [
       MenuItem(label: 'Show', onClicked: _appWindow.show),
       MenuItem(label: 'Hide', onClicked: _appWindow.hide),
@@ -63,9 +66,7 @@ class _MyAppState extends State<MyApp> {
             const Duration(milliseconds: 500),
             (timer) {
               _toogleTrayIcon = !_toogleTrayIcon;
-              _systemTray.setSystemTrayInfo(
-                iconPath: _toogleTrayIcon ? "" : path,
-              );
+              _systemTray.setImage(_toogleTrayIcon ? "" : path);
             },
           );
         },
@@ -78,9 +79,7 @@ class _MyAppState extends State<MyApp> {
           _timer?.cancel();
           _timer = null;
 
-          _systemTray.setSystemTrayInfo(
-            iconPath: path,
-          );
+          _systemTray.setImage(path);
         },
       ),
       MenuSeparator(),
@@ -91,32 +90,38 @@ class _MyAppState extends State<MyApp> {
             label: "setSystemTrayInfo",
             children: [
               MenuItem(
-                label: 'set title',
+                label: 'setTitle',
                 onClicked: () {
                   final String text = WordPair.random().asPascalCase;
-                  debugPrint("click 'set title' : $text");
-                  _systemTray.setSystemTrayInfo(
-                    title: text,
-                  );
+                  debugPrint("click 'setTitle' : $text");
+                  _systemTray.setTitle(text);
                 },
               ),
               MenuItem(
-                label: 'set icon path',
+                label: 'setImage',
                 onClicked: () {
-                  debugPrint("click 'set icon path' : $path");
-                  _systemTray.setSystemTrayInfo(
-                    iconPath: path,
-                  );
+                  String iconName = iconList[Random().nextInt(iconList.length)];
+                  String path = Platform.isWindows
+                      ? 'assets/$iconName.ico'
+                      : 'assets/$iconName.png';
+
+                  debugPrint("click 'setImage' : $path");
+                  _systemTray.setImage(path);
                 },
               ),
               MenuItem(
-                label: 'set toolTip',
+                label: 'setToolTip',
                 onClicked: () {
                   final String text = WordPair.random().asPascalCase;
-                  debugPrint("click 'set toolTip' : $text");
-                  _systemTray.setSystemTrayInfo(
-                    toolTip: text,
-                  );
+                  debugPrint("click 'setToolTip' : $text");
+                  _systemTray.setToolTip(text);
+                },
+              ),
+              MenuItem(
+                label: 'getTitle [macOS]',
+                onClicked: () async {
+                  String title = await _systemTray.getTitle();
+                  debugPrint("click 'getTitle' : $title");
                 },
               ),
             ],

example/pubspec.lock

@@ -204,7 +204,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.9"
+    version: "0.1.0"
   term_glyph:
     dependency: transitive
     description:

lib/src/app_window.dart

@@ -9,6 +9,7 @@ const String _kShowAppWindow = "ShowAppWindow";
 const String _kHideAppWindow = "HideAppWindow";
 const String _kCloseAppWindow = "CloseAppWindow";
 
+/// Representation of native window
 class AppWindow {
   AppWindow() {
     _platformChannel.setMethodCallHandler(_callbackHandler);
@@ -17,14 +18,17 @@ class AppWindow {
 
   static const MethodChannel _platformChannel = MethodChannel(_kChannelName);
 
+  /// Show native window
   Future<void> show() async {
     await _platformChannel.invokeMethod(_kShowAppWindow);
   }
 
+  /// Hide native window
   Future<void> hide() async {
     await _platformChannel.invokeMethod(_kHideAppWindow);
   }
 
+  /// Close native window
   Future<void> close() async {
     await _platformChannel.invokeMethod(_kCloseAppWindow);
   }