Tray-icon support

native/Avalonia.Native/src/OSX/Avalonia.Native.OSX.xcodeproj/project.pbxproj

@@ -22,6 +22,7 @@
 		37E2330F21583241000CB7E2 /* KeyTransform.mm in Sources */ = {isa = PBXBuildFile; fileRef = 37E2330E21583241000CB7E2 /* KeyTransform.mm */; };
 		520624B322973F4100C4DCEF /* menu.mm in Sources */ = {isa = PBXBuildFile; fileRef = 520624B222973F4100C4DCEF /* menu.mm */; };
 		522D5959258159C1006F7F7A /* Carbon.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 522D5958258159C1006F7F7A /* Carbon.framework */; };
+		523484CA26EA688F00EA0C2C /* trayicon.mm in Sources */ = {isa = PBXBuildFile; fileRef = 523484C926EA688F00EA0C2C /* trayicon.mm */; };
 		5B21A982216530F500CEE36E /* cursor.mm in Sources */ = {isa = PBXBuildFile; fileRef = 5B21A981216530F500CEE36E /* cursor.mm */; };
 		5B8BD94F215BFEA6005ED2A7 /* clipboard.mm in Sources */ = {isa = PBXBuildFile; fileRef = 5B8BD94E215BFEA6005ED2A7 /* clipboard.mm */; };
 		AB00E4F72147CA920032A60A /* main.mm in Sources */ = {isa = PBXBuildFile; fileRef = AB00E4F62147CA920032A60A /* main.mm */; };
@@ -51,6 +52,8 @@
 		37E2330E21583241000CB7E2 /* KeyTransform.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = KeyTransform.mm; sourceTree = "<group>"; };
 		520624B222973F4100C4DCEF /* menu.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = menu.mm; sourceTree = "<group>"; };
 		522D5958258159C1006F7F7A /* Carbon.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Carbon.framework; path = System/Library/Frameworks/Carbon.framework; sourceTree = SDKROOT; };
+		523484C926EA688F00EA0C2C /* trayicon.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = trayicon.mm; sourceTree = "<group>"; };
+		523484CB26EA68AA00EA0C2C /* trayicon.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = trayicon.h; sourceTree = "<group>"; };
 		5B21A981216530F500CEE36E /* cursor.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = cursor.mm; sourceTree = "<group>"; };
 		5B8BD94E215BFEA6005ED2A7 /* clipboard.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = clipboard.mm; sourceTree = "<group>"; };
 		5BF943652167AD1D009CAE35 /* cursor.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = cursor.h; sourceTree = "<group>"; };
@@ -114,6 +117,8 @@
 				AB00E4F62147CA920032A60A /* main.mm */,
 				37155CE3233C00EB0034DCE9 /* menu.h */,
 				520624B222973F4100C4DCEF /* menu.mm */,
+				523484C926EA688F00EA0C2C /* trayicon.mm */,
+				523484CB26EA68AA00EA0C2C /* trayicon.h */,
 				1A3E5EA723E9E83B00EDE661 /* rendertarget.mm */,
 				37A517B22159597E00FBA241 /* Screens.mm */,
 				37C09D8721580FE4006A6758 /* SystemDialogs.mm */,
@@ -204,6 +209,7 @@
 				1A1852DC23E05814008F0DED /* deadlock.mm in Sources */,
 				5B21A982216530F500CEE36E /* cursor.mm in Sources */,
 				37DDA9B0219330F8002E132B /* AvnString.mm in Sources */,
+				523484CA26EA688F00EA0C2C /* trayicon.mm in Sources */,
 				AB8F7D6B21482D7F0057DBA5 /* platformthreading.mm in Sources */,
 				1A3E5EA823E9E83B00EDE661 /* rendertarget.mm in Sources */,
 				1A3E5EAE23E9FB1300EDE661 /* cgl.mm in Sources */,

native/Avalonia.Native/src/OSX/common.h

@@ -22,6 +22,7 @@ extern AvnDragDropEffects ConvertDragDropEffects(NSDragOperation nsop);
 extern IAvnCursorFactory* CreateCursorFactory();
 extern IAvnGlDisplay* GetGlDisplay();
 extern IAvnMenu* CreateAppMenu(IAvnMenuEvents* events);
+extern IAvnTrayIcon* CreateTrayIcon();
 extern IAvnMenuItem* CreateAppMenuItem();
 extern IAvnMenuItem* CreateAppMenuItemSeparator();
 extern IAvnNativeControlHost* CreateNativeControlHost(NSView* parent);

native/Avalonia.Native/src/OSX/main.mm

@@ -303,6 +303,17 @@ virtual HRESULT ObtainGlDisplay(IAvnGlDisplay** ppv) override
         }
     }
 
+    virtual HRESULT CreateTrayIcon (IAvnTrayIcon** ppv) override
+    {
+        START_COM_CALL;
+
+        @autoreleasepool
+        {
+            *ppv = ::CreateTrayIcon();
+            return S_OK;
+        }
+    }
+
     virtual HRESULT CreateMenu (IAvnMenuEvents* cb, IAvnMenu** ppv) override
     {
         START_COM_CALL;

native/Avalonia.Native/src/OSX/trayicon.h

@@ -0,0 +1,33 @@
+//
+//  trayicon.h
+//  Avalonia.Native.OSX
+//
+//  Created by Dan Walmsley on 09/09/2021.
+//  Copyright © 2021 Avalonia. All rights reserved.
+//
+
+#ifndef trayicon_h
+#define trayicon_h
+
+#include "common.h"
+
+class AvnTrayIcon : public ComSingleObject<IAvnTrayIcon, &IID_IAvnTrayIcon>
+{
+private:
+    NSStatusItem* _native;
+
+public:
+    FORWARD_IUNKNOWN()
+
+    AvnTrayIcon();
+
+    ~AvnTrayIcon ();
+
+    virtual HRESULT SetIcon (void* data, size_t length) override;
+
+    virtual HRESULT SetMenu (IAvnMenu* menu) override;
+
+    virtual HRESULT SetIsVisible (bool isVisible) override;
+};
+
+#endif /* trayicon_h */

native/Avalonia.Native/src/OSX/trayicon.mm

@@ -0,0 +1,85 @@
+#include "common.h"
+#include "trayicon.h"
+#include "menu.h"
+
+extern IAvnTrayIcon* CreateTrayIcon()
+{
+    @autoreleasepool
+    {
+        return new AvnTrayIcon();
+    }
+}
+
+AvnTrayIcon::AvnTrayIcon()
+{
+    _native = [[NSStatusBar systemStatusBar] statusItemWithLength: NSSquareStatusItemLength];
+
+}
+
+AvnTrayIcon::~AvnTrayIcon()
+{
+    if(_native != nullptr)
+    {
+        [[_native statusBar] removeStatusItem:_native];
+        _native = nullptr;
+    }
+}
+
+HRESULT AvnTrayIcon::SetIcon (void* data, size_t length)
+{
+    START_COM_CALL;
+
+    @autoreleasepool
+    {
+        if(data != nullptr)
+        {
+            NSData *imageData = [NSData dataWithBytes:data length:length];
+            NSImage *image = [[NSImage alloc] initWithData:imageData];
+
+            NSSize originalSize = [image size];
+
+            NSSize size;
+            size.height = [[NSFont menuFontOfSize:0] pointSize] * 1.333333;
+
+            auto scaleFactor = size.height / originalSize.height;
+            size.width = originalSize.width * scaleFactor;
+
+            [image setSize: size];
+            [_native setImage:image];
+        }
+        else
+        {
+            [_native setImage:nullptr];
+        }
+        return S_OK;
+    }
+}
+
+HRESULT AvnTrayIcon::SetMenu (IAvnMenu* menu)
+{
+    START_COM_CALL;
+
+    @autoreleasepool
+    {
+        auto appMenu = dynamic_cast<AvnAppMenu*>(menu);
+
+        if(appMenu != nullptr)
+        {
+            [_native setMenu:appMenu->GetNative()];	
+        }
+    }
+
+    return  S_OK;
+}
+
+HRESULT AvnTrayIcon::SetIsVisible(bool isVisible)
+{
+    START_COM_CALL;
+
+    @autoreleasepool
+    {
+        [_native setVisible:isVisible];
+    }
+
+    return  S_OK;
+}

samples/ControlCatalog/App.xaml

@@ -1,5 +1,8 @@
 <Application xmlns="https://github.com/avaloniaui"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:vm="using:ControlCatalog.ViewModels"
+             x:DataType="vm:ApplicationViewModel"
+             x:CompileBindings="True"
              x:Class="ControlCatalog.App">
   <Application.Styles>
     <Style Selector="TextBlock.h1">
@@ -22,6 +25,26 @@
     <Style Selector="Label.h3">
       <Setter Property="FontSize" Value="12" />
     </Style>
-    <StyleInclude Source="/SideBar.xaml"/>
+    <StyleInclude Source="/SideBar.xaml" />
   </Application.Styles>
+  <TrayIcon.Icons>
+    <TrayIcons>
+      <TrayIcon Icon="/Assets/test_icon.ico" ToolTipText="Avalonia Tray Icon ToolTip">
+        <TrayIcon.Menu>
+          <NativeMenu>
+            <NativeMenuItem Header="Settings">
+              <NativeMenu>
+                <NativeMenuItem Header="Option 1" ToggleType="Radio" IsChecked="True" Command="{Binding ToggleCommand}" />
+                <NativeMenuItem Header="Option 2" ToggleType="Radio" IsChecked="True" Command="{Binding ToggleCommand}" />
+                <NativeMenuItemSeparator />
+                <NativeMenuItem Header="Option 3" ToggleType="CheckBox" IsChecked="True" Command="{Binding ToggleCommand}" />
+                <NativeMenuItem Icon="/Assets/test_icon.ico" Header="Restore Defaults" Command="{Binding ToggleCommand}" />
+              </NativeMenu>
+            </NativeMenuItem>
+            <NativeMenuItem Header="Exit" Command="{Binding ExitCommand}" />
+          </NativeMenu>
+        </TrayIcon.Menu>
+      </TrayIcon>
+    </TrayIcons>
+  </TrayIcon.Icons>
 </Application>

samples/ControlCatalog/App.xaml.cs

@@ -1,14 +1,21 @@
 using System;
 using Avalonia;
+using Avalonia.Controls;
 using Avalonia.Controls.ApplicationLifetimes;
 using Avalonia.Markup.Xaml;
 using Avalonia.Markup.Xaml.Styling;
 using Avalonia.Styling;
+using ControlCatalog.ViewModels;
 
 namespace ControlCatalog
 {
     public class App : Application
     {
+        public App()
+        {
+            DataContext = new ApplicationViewModel();
+        }
+
         private static readonly StyleInclude DataGridFluent = new StyleInclude(new Uri("avares://ControlCatalog/Styles"))
         {
             Source = new Uri("avares://Avalonia.Controls.DataGrid/Themes/Fluent.xaml")
@@ -97,7 +104,9 @@ public override void Initialize()
         public override void OnFrameworkInitializationCompleted()
         {
             if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktopLifetime)
+            {
                 desktopLifetime.MainWindow = new MainWindow();
+            }
             else if (ApplicationLifetime is ISingleViewApplicationLifetime singleViewLifetime)
                 singleViewLifetime.MainView = new MainView();
 

samples/ControlCatalog/MainWindow.xaml.cs

@@ -35,6 +35,8 @@ public MainWindow()
 
             var mainMenu = this.FindControl<Menu>("MainMenu");
             mainMenu.AttachedToVisualTree += MenuAttached;
+
+            ExtendClientAreaChromeHints = Avalonia.Platform.ExtendClientAreaChromeHints.OSXThickTitleBar;
         }
 
         public static string MenuQuitHeader => RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? "Quit Avalonia" : "E_xit";

samples/ControlCatalog/ViewModels/ApplicationViewModel.cs

@@ -0,0 +1,26 @@
+using Avalonia;
+using Avalonia.Controls.ApplicationLifetimes;
+using MiniMvvm;
+
+namespace ControlCatalog.ViewModels
+{
+    public class ApplicationViewModel : ViewModelBase
+    {
+        public ApplicationViewModel()
+        {
+            ExitCommand = MiniCommand.Create(() =>
+            {
+                if (Application.Current.ApplicationLifetime is IClassicDesktopStyleApplicationLifetime lifetime)
+                {
+                    lifetime.Shutdown();
+                }
+            });
+
+            ToggleCommand = MiniCommand.Create(() => { });
+        }
+
+        public MiniCommand ExitCommand { get; }
+
+        public MiniCommand ToggleCommand { get; }
+    }
+}

src/Avalonia.Base/Logging/LogArea.cs

@@ -39,5 +39,10 @@ public static class LogArea
         /// The log event comes from Win32Platform.
         /// </summary>
         public const string Win32Platform = nameof(Win32Platform);
+
+        /// <summary>
+        /// The log event comes from X11Platform.
+        /// </summary>
+        public const string X11Platform = nameof(X11Platform);
     }
 }

src/Avalonia.Controls/ApiCompatBaseline.txt

@@ -37,6 +37,7 @@ MembersMustExist : Member 'public System.Action<Avalonia.Size> Avalonia.Controls
 MembersMustExist : Member 'public void Avalonia.Controls.Embedding.Offscreen.OffscreenTopLevelImplBase.Resized.set(System.Action<Avalonia.Size>)' does not exist in the implementation but it does exist in the contract.
 MembersMustExist : Member 'public void Avalonia.Controls.Embedding.Offscreen.OffscreenTopLevelImplBase.SetCursor(Avalonia.Platform.IPlatformHandle)' does not exist in the implementation but it does exist in the contract.
 MembersMustExist : Member 'public Avalonia.AvaloniaProperty Avalonia.AvaloniaProperty Avalonia.Controls.Notifications.NotificationCard.CloseOnClickProperty' does not exist in the implementation but it does exist in the contract.
+InterfacesShouldHaveSameMembers : Interface member 'public void Avalonia.Controls.Platform.ITopLevelNativeMenuExporter.SetNativeMenu(Avalonia.Controls.NativeMenu)' is present in the contract but not in the implementation.
 EnumValuesMustMatch : Enum value 'Avalonia.Platform.ExtendClientAreaChromeHints Avalonia.Platform.ExtendClientAreaChromeHints.Default' is (System.Int32)2 in the implementation but (System.Int32)1 in the contract.
 InterfacesShouldHaveSameMembers : Interface member 'public System.Nullable<Avalonia.Size> Avalonia.Platform.ITopLevelImpl.FrameSize' is present in the implementation but not in the contract.
 InterfacesShouldHaveSameMembers : Interface member 'public System.Nullable<Avalonia.Size> Avalonia.Platform.ITopLevelImpl.FrameSize.get()' is present in the implementation but not in the contract.
@@ -55,4 +56,5 @@ InterfacesShouldHaveSameMembers : Interface member 'public void Avalonia.Platfor
 InterfacesShouldHaveSameMembers : Interface member 'public void Avalonia.Platform.IWindowImpl.Resize(Avalonia.Size)' is present in the contract but not in the implementation.
 MembersMustExist : Member 'public void Avalonia.Platform.IWindowImpl.Resize(Avalonia.Size)' does not exist in the implementation but it does exist in the contract.
 InterfacesShouldHaveSameMembers : Interface member 'public void Avalonia.Platform.IWindowImpl.Resize(Avalonia.Size, Avalonia.Platform.PlatformResizeReason)' is present in the implementation but not in the contract.
-Total Issues: 56
+InterfacesShouldHaveSameMembers : Interface member 'public Avalonia.Platform.ITrayIconImpl Avalonia.Platform.IWindowingPlatform.CreateTrayIcon()' is present in the implementation but not in the contract.
+Total Issues: 58

src/Avalonia.Controls/NativeMenu.Export.cs

@@ -52,15 +52,10 @@ static void SetIsNativeMenuExported(TopLevel tl, bool value)
         }
 
         public static readonly AttachedProperty<NativeMenu> MenuProperty
-            = AvaloniaProperty.RegisterAttached<NativeMenu, AvaloniaObject, NativeMenu>("Menu"/*, validate:
-                (o, v) =>
-                {
-                    if(!(o is Application || o is TopLevel))
-                        throw new InvalidOperationException("NativeMenu.Menu property isn't valid on "+o.GetType());
-                    return v;
-                }*/);
+            = AvaloniaProperty.RegisterAttached<NativeMenu, AvaloniaObject, NativeMenu>("Menu");
 
         public static void SetMenu(AvaloniaObject o, NativeMenu menu) => o.SetValue(MenuProperty, menu);
+
         public static NativeMenu GetMenu(AvaloniaObject o) => o.GetValue(MenuProperty);
 
         static NativeMenu()
@@ -79,6 +74,10 @@ static NativeMenu()
                 {
                     GetInfo(tl).Exporter?.SetNativeMenu(args.NewValue.GetValueOrDefault());
                 }
+                else if(args.Sender is INativeMenuExporterProvider provider)
+                {
+                    provider.NativeMenuExporter?.SetNativeMenu(args.NewValue.GetValueOrDefault());
+                }
             });
         }
     }

src/Avalonia.Controls/Platform/ITopLevelNativeMenuExporter.cs

@@ -1,14 +1,25 @@
 using System;
-using System.Collections.Generic;
 using Avalonia.Platform;
 
+#nullable enable
+
 namespace Avalonia.Controls.Platform
 {
-    public interface ITopLevelNativeMenuExporter
+    public interface INativeMenuExporter
+    {
+        void SetNativeMenu(NativeMenu? menu);
+    }
+
+    public interface ITopLevelNativeMenuExporter : INativeMenuExporter
     {
         bool IsNativeMenuExported { get; }
+
         event EventHandler OnIsNativeMenuExportedChanged;
-        void SetNativeMenu(NativeMenu menu);
+    }
+
+    public interface INativeMenuExporterProvider
+    {
+        INativeMenuExporter? NativeMenuExporter { get; }
     }
 
     public interface ITopLevelImplWithNativeMenuExporter : ITopLevelImpl