Merge pull request #3839 from AvaloniaUI/feature/osx-native-menuicon-icons

OSX NativeMenu Icons

native/Avalonia.Native/inc/avalonia-native.h

@@ -1,5 +1,6 @@
 #include "com.h"
 #include "key.h"
+#include "stddef.h"
 
 #define AVNCOM(name, id) COMINTERFACE(name, 2e2cda0a, 9ae5, 4f1b, 8e, 20, 08, 1a, 04, 27, 9f, id)
 
@@ -415,6 +416,7 @@ AVNCOM(IAvnMenuItem, 19) : IUnknown
     virtual HRESULT SetAction (IAvnPredicateCallback* predicate, IAvnActionCallback* callback) = 0;
     virtual HRESULT SetIsChecked (bool isChecked) = 0;
     virtual HRESULT SetToggleType (AvnMenuItemToggleType toggleType) = 0;
+    virtual HRESULT SetIcon (void* data, size_t length) = 0;
 };
 
 AVNCOM(IAvnMenuEvents, 1A) : IUnknown

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

@@ -53,6 +53,8 @@ public:
     
     virtual HRESULT SetToggleType (AvnMenuItemToggleType toggleType) override;
     
+    virtual HRESULT SetIcon (void* data, size_t length) override;
+    
     bool EvaluateItemEnabled();
     
     void RaiseOnClicked();

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

@@ -192,6 +192,34 @@ HRESULT AvnAppMenuItem::SetToggleType(AvnMenuItemToggleType toggleType)
     }
 }
 
+HRESULT AvnAppMenuItem::SetIcon(void *data, size_t length)
+{
+    @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;
+    }
+}
+
 bool AvnAppMenuItem::EvaluateItemEnabled()
 {
     if(_predicate != nullptr)

samples/ControlCatalog/MainWindow.xaml

@@ -14,9 +14,9 @@
       <NativeMenuItem Header="File">
         <NativeMenuItem.Menu>
           <NativeMenu>
-            <NativeMenuItem Header="Open" Clicked="OnOpenClicked" Gesture="Ctrl+O"/>
+            <NativeMenuItem Icon="/Assets/test_icon.ico" Header="Open" Clicked="OnOpenClicked" Gesture="Ctrl+O"/>
             <NativeMenuItemSeperator/>
-            <NativeMenuItem Header="Recent">
+            <NativeMenuItem Icon="/Assets/github_icon.png" Header="Recent">
               <NativeMenuItem.Menu>
                 <NativeMenu/>
               </NativeMenuItem.Menu>

src/Avalonia.Controls/NativeMenuItem.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Windows.Input;
 using Avalonia.Input;
+using Avalonia.Media.Imaging;
 using Avalonia.Utilities;
 
 namespace Avalonia.Controls
@@ -13,6 +14,7 @@ namespace Avalonia.Controls
         private ICommand _command;
         private bool _isChecked = false;
         private NativeMenuItemToggleType _toggleType;
+        private IBitmap _icon;
 
         private NativeMenu _menu;
 
@@ -71,6 +73,16 @@ namespace Avalonia.Controls
             }
         }
 
+        public static readonly DirectProperty<NativeMenuItem, IBitmap> IconProperty =
+            AvaloniaProperty.RegisterDirect<NativeMenuItem, IBitmap>(nameof(Icon), o => o.Icon, (o, v) => o.Icon = v);
+
+
+        public IBitmap Icon
+        {
+            get => _icon;
+            set => SetAndRaise(IconProperty, ref _icon, value);
+        }  
+
         public static readonly DirectProperty<NativeMenuItem, string> HeaderProperty =
             AvaloniaProperty.RegisterDirect<NativeMenuItem, string>(nameof(Header), o => o.Header, (o, v) => o.Header = v);
 

src/Avalonia.Native/IAvnMenuItem.cs

@@ -1,6 +1,8 @@
 using System;
+using System.IO;
 using System.Reactive.Disposables;
 using Avalonia.Controls;
+using Avalonia.Media.Imaging;
 using Avalonia.Platform.Interop;
 
 namespace Avalonia.Native.Interop
@@ -31,6 +33,28 @@ namespace Avalonia.Native.Interop
             ToggleType = (AvnMenuItemToggleType)toggleType;
         }
 
+        private unsafe void UpdateIcon (IBitmap icon)
+        {
+            if(icon is null)
+            {
+                SetIcon(IntPtr.Zero, 0);
+            }
+            else
+            {
+                using(var ms = new MemoryStream())
+                {
+                    icon.Save(ms);
+
+                    var imageData = ms.ToArray();
+
+                    fixed(void* ptr = imageData)
+                    {
+                        SetIcon(new IntPtr(ptr), imageData.Length);
+                    }
+                }
+            }
+        }
+
         private void UpdateGesture(Input.KeyGesture gesture)
         {
             // todo ensure backend can cope with setting null gesture.
@@ -80,6 +104,8 @@ namespace Avalonia.Native.Interop
 
                 UpdateToggleType(item.ToggleType);
 
+                UpdateIcon(item.Icon);
+
                 UpdateIsChecked(item.IsChecked);
 
                 _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.HeaderProperty)
@@ -96,6 +122,9 @@ namespace Avalonia.Native.Interop
 
                 _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.IsCheckedProperty)
                     .Subscribe(x => UpdateIsChecked(x)));
+
+                _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.IconProperty)
+                    .Subscribe(x => UpdateIcon(x)));
             }
         }
 

src/Markup/Avalonia.Markup.Xaml/XamlIl/CompilerExtensions/AvaloniaXamlIlLanguage.cs

@@ -100,6 +100,7 @@ namespace Avalonia.Markup.Xaml.XamlIl.CompilerExtensions
                     => AddType(typeSystem.GetType(type), typeSystem.GetType(conv));
                 
                 Add("Avalonia.Media.IImage","Avalonia.Markup.Xaml.Converters.BitmapTypeConverter");
+                Add("Avalonia.Media.Imaging.IBitmap","Avalonia.Markup.Xaml.Converters.BitmapTypeConverter");
                 var ilist = typeSystem.GetType("System.Collections.Generic.IList`1");
                 AddType(ilist.MakeGenericType(typeSystem.GetType("Avalonia.Point")),
                     typeSystem.GetType("Avalonia.Markup.Xaml.Converters.PointsListTypeConverter"));