Refactor tray icon API for visibility and optional text

Replaces Show/Hide methods with SetVisible for tray icon visibility across all platforms. Title and tooltip setters/getters now use std::optional to allow clearing values. Updates C/C++ API, documentation, and example usage to reflect these changes for improved consistency and flexibility.

Author: lijy91

examples/tray_icon_c_example/main.c

@@ -188,7 +188,7 @@ int main() {
                                 on_tray_double_clicked, NULL);
 
   // Show the tray icon
-  if (native_tray_icon_show(tray_icon)) {
+  if (native_tray_icon_set_visible(tray_icon, true)) {
     printf("Tray icon is now visible\n");
   } else {
     printf("Warning: Failed to show tray icon\n");

examples/tray_icon_example/main.cpp

@@ -120,7 +120,7 @@ int main() {
   trayIcon->SetContextMenu(context_menu);
 
   // Show the tray icon
-  if (trayIcon->Show()) {
+  if (trayIcon->SetVisible(true)) {
     std::cout << "Tray icon is now visible!" << std::endl;
   } else {
     std::cerr << "Failed to show tray icon!" << std::endl;
@@ -170,7 +170,7 @@ int main() {
   }
 
   // Hide the tray icon before exiting
-  trayIcon->Hide();
+  trayIcon->SetVisible(false);
   std::cout << "Exiting TrayIcon Example..." << std::endl;
 
   // Cleanup

examples/window_c_example/main.c

@@ -349,7 +349,7 @@ int main() {
         native_tray_icon_add_listener(g_tray_icon, NATIVE_TRAY_ICON_EVENT_RIGHT_CLICKED, on_tray_icon_right_clicked, NULL);
         native_tray_icon_add_listener(g_tray_icon, NATIVE_TRAY_ICON_EVENT_DOUBLE_CLICKED, on_tray_icon_double_clicked, NULL);
 
-        native_tray_icon_show(g_tray_icon);
+        native_tray_icon_set_visible(g_tray_icon, true);
     } else {
         fprintf(stderr, "Failed to create tray.\n");
     }

examples/window_example/main.cpp

@@ -81,9 +81,8 @@ int main() {
         "XFg23zDhiRuqUXbBi1whJ9enqSQUWa7x3IcWHH0xDhLfUVYSpsWt6LMfZQwwX/"
         "wLVwWPG97osM9Wf7Df6GGOwnsP4BQFiPuOZ8wJUAAAAASUVORK5CYII=");
     std::cout << "Tray ID: " << tray_icon.id << std::endl;
-    std::cout << "Tray Title: " << tray_icon.GetTitle() << std::endl;
-
-    tray_icon.Show();
+    auto title = tray_icon.GetTitle();
+    std::cout << "Tray Title: " << (title.has_value() ? title.value() : "(no title)") << std::endl;
 
     // Create context menu
     auto context_menu = Menu::Create();

src/capi/tray_icon_c.cpp

@@ -85,12 +85,16 @@ void native_tray_icon_set_icon(native_tray_icon_t tray_icon, const char* icon) {
 
 void native_tray_icon_set_title(native_tray_icon_t tray_icon,
                                 const char* title) {
-  if (!tray_icon || !title)
+  if (!tray_icon)
     return;
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    tray_icon_ptr->SetTitle(title);
+    if (title) {
+      tray_icon_ptr->SetTitle(std::string(title));
+    } else {
+      tray_icon_ptr->SetTitle(std::nullopt);
+    }
   } catch (...) {
     // Ignore exceptions
   }
@@ -102,20 +106,29 @@ char* native_tray_icon_get_title(native_tray_icon_t tray_icon) {
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    return to_c_str(tray_icon_ptr->GetTitle());
+    auto title = tray_icon_ptr->GetTitle();
+    if (title.has_value()) {
+      return to_c_str(title.value());
+    } else {
+      return nullptr;
+    }
   } catch (...) {
     return nullptr;
   }
 }
 
 void native_tray_icon_set_tooltip(native_tray_icon_t tray_icon,
                                   const char* tooltip) {
-  if (!tray_icon || !tooltip)
+  if (!tray_icon)
     return;
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    tray_icon_ptr->SetTooltip(tooltip);
+    if (tooltip) {
+      tray_icon_ptr->SetTooltip(std::string(tooltip));
+    } else {
+      tray_icon_ptr->SetTooltip(std::nullopt);
+    }
   } catch (...) {
     // Ignore exceptions
   }
@@ -127,7 +140,12 @@ char* native_tray_icon_get_tooltip(native_tray_icon_t tray_icon) {
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    return to_c_str(tray_icon_ptr->GetTooltip());
+    auto tooltip = tray_icon_ptr->GetTooltip();
+    if (tooltip.has_value()) {
+      return to_c_str(tooltip.value());
+    } else {
+      return nullptr;
+    }
   } catch (...) {
     return nullptr;
   }
@@ -190,25 +208,13 @@ bool native_tray_icon_get_bounds(native_tray_icon_t tray_icon,
   }
 }
 
-bool native_tray_icon_show(native_tray_icon_t tray_icon) {
-  if (!tray_icon)
-    return false;
-
-  try {
-    auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    return tray_icon_ptr->Show();
-  } catch (...) {
-    return false;
-  }
-}
-
-bool native_tray_icon_hide(native_tray_icon_t tray_icon) {
+bool native_tray_icon_set_visible(native_tray_icon_t tray_icon, bool visible) {
   if (!tray_icon)
     return false;
 
   try {
     auto tray_icon_ptr = static_cast<TrayIcon*>(tray_icon);
-    return tray_icon_ptr->Hide();
+    return tray_icon_ptr->SetVisible(visible);
   } catch (...) {
     return false;
   }

src/capi/tray_icon_c.h

@@ -108,15 +108,15 @@ void native_tray_icon_set_icon(native_tray_icon_t tray_icon, const char* icon);
 /**
  * Set the title text for the tray icon
  * @param tray_icon The tray icon
- * @param title The title text to set
+ * @param title The title text to set, or NULL to clear the title
  */
 FFI_PLUGIN_EXPORT
 void native_tray_icon_set_title(native_tray_icon_t tray_icon, const char* title);
 
 /**
  * Get the title text of the tray icon
  * @param tray_icon The tray icon
- * @return The title text, or NULL if error. Caller must free the returned
+ * @return The title text, or NULL if no title is set or error. Caller must free the returned
  * string.
  */
 FFI_PLUGIN_EXPORT
@@ -125,15 +125,15 @@ char* native_tray_icon_get_title(native_tray_icon_t tray_icon);
 /**
  * Set the tooltip text for the tray icon
  * @param tray_icon The tray icon
- * @param tooltip The tooltip text to set
+ * @param tooltip The tooltip text to set, or NULL to clear the tooltip
  */
 FFI_PLUGIN_EXPORT
 void native_tray_icon_set_tooltip(native_tray_icon_t tray_icon, const char* tooltip);
 
 /**
  * Get the tooltip text of the tray icon
  * @param tray_icon The tray icon
- * @return The tooltip text, or NULL if error. Caller must free the returned
+ * @return The tooltip text, or NULL if no tooltip is set or error. Caller must free the returned
  * string.
  */
 FFI_PLUGIN_EXPORT
@@ -165,20 +165,13 @@ FFI_PLUGIN_EXPORT
 bool native_tray_icon_get_bounds(native_tray_icon_t tray_icon, native_rectangle_t* bounds);
 
 /**
- * Show the tray icon in the system tray
+ * Set the visibility of the tray icon in the system tray
  * @param tray_icon The tray icon
- * @return true if shown successfully, false otherwise
+ * @param visible true to show the icon, false to hide it
+ * @return true if visibility was changed successfully, false otherwise
  */
 FFI_PLUGIN_EXPORT
-bool native_tray_icon_show(native_tray_icon_t tray_icon);
-
-/**
- * Hide the tray icon from the system tray
- * @param tray_icon The tray icon
- * @return true if hidden successfully, false otherwise
- */
-FFI_PLUGIN_EXPORT
-bool native_tray_icon_hide(native_tray_icon_t tray_icon);
+bool native_tray_icon_set_visible(native_tray_icon_t tray_icon, bool visible);
 
 /**
  * Check if the tray icon is currently visible

src/platform/linux/tray_icon_linux.cpp

@@ -151,24 +151,21 @@ Rectangle TrayIcon::GetBounds() {
   return bounds;
 }
 
-bool TrayIcon::Show() {
-  if (pimpl_->app_indicator_) {
-    app_indicator_set_status(pimpl_->app_indicator_,
-                             APP_INDICATOR_STATUS_ACTIVE);
-    pimpl_->visible_ = true;
-    return true;
+bool TrayIcon::SetVisible(bool visible) {
+  if (!pimpl_->app_indicator_) {
+    return false;
   }
-  return false;
-}
 
-bool TrayIcon::Hide() {
-  if (pimpl_->app_indicator_) {
+  if (visible) {
+    app_indicator_set_status(pimpl_->app_indicator_,
+                             APP_INDICATOR_STATUS_ACTIVE);
+  } else {
     app_indicator_set_status(pimpl_->app_indicator_,
                              APP_INDICATOR_STATUS_PASSIVE);
-    pimpl_->visible_ = false;
-    return true;
   }
-  return false;
+  
+  pimpl_->visible_ = visible;
+  return true;
 }
 
 bool TrayIcon::IsVisible() {

src/platform/macos/tray_icon_macos.mm

@@ -25,10 +25,10 @@ @interface TrayIconMenuDelegate : NSObject <NSMenuDelegate>
 // Private implementation class
 class TrayIcon::Impl {
  public:
-  Impl() : ns_status_item_(nil), delegate_(nil), menu_delegate_(nil), visible_(false) {}
+  Impl() : ns_status_item_(nil), delegate_(nil), menu_delegate_(nil) {}
 
   Impl(NSStatusItem* status_item)
-      : ns_status_item_(status_item), delegate_(nil), menu_delegate_(nil), visible_(false) {
+      : ns_status_item_(status_item), delegate_(nil), menu_delegate_(nil) {
     if (status_item) {
       // Create and set up delegate
       delegate_ = [[TrayIconDelegate alloc] init];
@@ -82,9 +82,6 @@ @interface TrayIconMenuDelegate : NSObject <NSMenuDelegate>
   TrayIconDelegate* delegate_;
   TrayIconMenuDelegate* menu_delegate_;
   std::shared_ptr<Menu> context_menu_;
-  std::string title_;
-  std::string tooltip_;
-  bool visible_;
 };
 
 TrayIcon::TrayIcon() : pimpl_(std::make_unique<Impl>()) {
@@ -164,30 +161,46 @@ @interface TrayIconMenuDelegate : NSObject <NSMenuDelegate>
   }
 }
 
-void TrayIcon::SetTitle(std::string title) {
-  pimpl_->title_ = title;
-
+void TrayIcon::SetTitle(std::optional<std::string> title) {
   if (pimpl_->ns_status_item_ && pimpl_->ns_status_item_.button) {
-    NSString* titleString = [NSString stringWithUTF8String:title.c_str()];
-    [pimpl_->ns_status_item_.button setTitle:titleString];
+    if (title.has_value()) {
+      NSString* titleString = [NSString stringWithUTF8String:title.value().c_str()];
+      [pimpl_->ns_status_item_.button setTitle:titleString];
+    } else {
+      [pimpl_->ns_status_item_.button setTitle:@""];
+    }
   }
 }
 
-std::string TrayIcon::GetTitle() {
-  return pimpl_->title_;
+std::optional<std::string> TrayIcon::GetTitle() {
+  if (pimpl_->ns_status_item_ && pimpl_->ns_status_item_.button) {
+    NSString* titleString = [pimpl_->ns_status_item_.button title];
+    if (titleString && [titleString length] > 0) {
+      return std::string([titleString UTF8String]);
+    }
+  }
+  return std::nullopt;
 }
 
-void TrayIcon::SetTooltip(std::string tooltip) {
-  pimpl_->tooltip_ = tooltip;
-
+void TrayIcon::SetTooltip(std::optional<std::string> tooltip) {
   if (pimpl_->ns_status_item_ && pimpl_->ns_status_item_.button) {
-    NSString* tooltipString = [NSString stringWithUTF8String:tooltip.c_str()];
-    [pimpl_->ns_status_item_.button setToolTip:tooltipString];
+    if (tooltip.has_value()) {
+      NSString* tooltipString = [NSString stringWithUTF8String:tooltip.value().c_str()];
+      [pimpl_->ns_status_item_.button setToolTip:tooltipString];
+    } else {
+      [pimpl_->ns_status_item_.button setToolTip:nil];
+    }
   }
 }
 
-std::string TrayIcon::GetTooltip() {
-  return pimpl_->tooltip_;
+std::optional<std::string> TrayIcon::GetTooltip() {
+  if (pimpl_->ns_status_item_ && pimpl_->ns_status_item_.button) {
+    NSString* tooltipString = [pimpl_->ns_status_item_.button toolTip];
+    if (tooltipString && [tooltipString length] > 0) {
+      return std::string([tooltipString UTF8String]);
+    }
+  }
+  return std::nullopt;
 }
 
 void TrayIcon::SetContextMenu(std::shared_ptr<Menu> menu) {
@@ -224,29 +237,20 @@ @interface TrayIconMenuDelegate : NSObject <NSMenuDelegate>
   return bounds;
 }
 
-bool TrayIcon::Show() {
-  if (pimpl_->ns_status_item_) {
-    [pimpl_->ns_status_item_ setVisible:YES];
-    pimpl_->visible_ = true;
-    return true;
+bool TrayIcon::SetVisible(bool visible) {
+  if (!pimpl_->ns_status_item_) {
+    return false;
   }
-  return false;
-}
 
-bool TrayIcon::Hide() {
-  if (pimpl_->ns_status_item_) {
-    [pimpl_->ns_status_item_ setVisible:NO];
-    pimpl_->visible_ = false;
-    return true;
-  }
-  return false;
+  [pimpl_->ns_status_item_ setVisible:visible ? YES : NO];
+  return true;
 }
 
 bool TrayIcon::IsVisible() {
   if (pimpl_->ns_status_item_) {
     return [pimpl_->ns_status_item_ isVisible] == YES;
   }
-  return pimpl_->visible_;
+  return false;
 }
 
 bool TrayIcon::OpenContextMenu(double x, double y) {

src/platform/macos/tray_manager_macos.mm

@@ -28,7 +28,7 @@
     auto tray = pair.second;
     if (tray) {
       try {
-        tray->Hide();
+        tray->SetVisible(false);
       } catch (...) {
         // Ignore exceptions during cleanup
       }
@@ -62,6 +62,8 @@
   NSStatusBar* status_bar = [NSStatusBar systemStatusBar];
   NSStatusItem* status_item = [status_bar statusItemWithLength:NSVariableStatusItemLength];
 
+  std::cout << status_item.visible << std::endl;
+
   auto tray = std::make_shared<TrayIcon>((__bridge void*)status_item);
   tray->id = next_tray_id_++;
   trays_[tray->id] = tray;