IsVisible for NativeMenuItem(s) (#14567)

* IsVisible for nativemenuitems

* implementation for windows

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

Co-authored-by: jp2masa <[email protected]>

* Update menu.h

* address review changes

* add hidden option to ControlCatalog

---------

Co-authored-by: jp2masa <[email protected]>
Co-authored-by: Max Katz <[email protected]>

Author: 3 people

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

@@ -51,7 +51,9 @@ class AvnAppMenuItem : public ComSingleObject<IAvnMenuItem, &IID_IAvnMenuItem>
     virtual HRESULT SetAction (IAvnPredicateCallback* predicate, IAvnActionCallback* callback) override;
 
     virtual HRESULT SetIsChecked (bool isChecked) override;
-    
+
+    virtual HRESULT SetIsVisible (bool isVisible) override;
+        
     virtual HRESULT SetToggleType (AvnMenuItemToggleType toggleType) override;
 
     virtual HRESULT SetIcon (void* data, size_t length) override;

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

@@ -205,6 +205,17 @@ - (void)didSelectItem:(nullable id)sender
     }
 }
 
+HRESULT AvnAppMenuItem::SetIsVisible (bool isVisible)
+{
+    START_COM_CALL;
+    
+    @autoreleasepool
+    {
+        [_native setHidden:!isVisible];
+        return S_OK;
+    }
+}
+
 HRESULT AvnAppMenuItem::SetToggleType(AvnMenuItemToggleType toggleType)
 {
     START_COM_CALL;

samples/ControlCatalog/App.xaml

@@ -75,6 +75,7 @@
                 <NativeMenuItem Header="Option 3" ToggleType="CheckBox" IsChecked="True" />
                 <NativeMenuItem Icon="/Assets/test_icon.ico" Header="Restore Defaults" Command="{Binding RestoreDefault}" />
                 <NativeMenuItem Header="Disabled option" IsEnabled="False" />
+                <NativeMenuItem Header="Hidden option" IsVisible="False" />
               </NativeMenu>
             </NativeMenuItem>
             <NativeMenuItem Header="Exit" Command="{Binding ExitCommand}" />

src/Avalonia.Controls/NativeMenuBarPresenter.cs

@@ -26,6 +26,7 @@ internal class NativeMenuBarPresenter : Menu
                 [!MenuItem.IconProperty] = nativeItem.GetObservable(NativeMenuItem.IconProperty)
                     .Select(i => i is { } bitmap ? new Image { Source = bitmap } : null).ToBinding(),
                 [!MenuItem.IsEnabledProperty] = nativeItem.GetObservable(NativeMenuItem.IsEnabledProperty).ToBinding(),
+                [!MenuItem.IsVisibleProperty] = nativeItem.GetObservable(NativeMenuItem.IsVisibleProperty).ToBinding(),
                 [!MenuItem.CommandProperty] = nativeItem.GetObservable(NativeMenuItem.CommandProperty).ToBinding(),
                 [!MenuItem.CommandParameterProperty] =
                     nativeItem.GetObservable(NativeMenuItem.CommandParameterProperty).ToBinding(),

src/Avalonia.Controls/NativeMenuItem.cs

@@ -144,6 +144,21 @@ public bool IsEnabled
             set => SetValue(IsEnabledProperty, value);
         }
 
+        /// <summary>
+        /// Defines the <see cref="IsVisible"/> property.
+        /// </summary>
+        public static readonly StyledProperty<bool> IsVisibleProperty =
+           Visual.IsVisibleProperty.AddOwner<NativeMenuItem>();
+
+        /// <summary>
+        /// Gets or sets a value indicating whether this menu item is visible.
+        /// </summary>
+        public bool IsVisible
+        {
+            get => GetValue(IsVisibleProperty);
+            set => SetValue(IsVisibleProperty, value);
+        }
+
         void CanExecuteChanged()
         {
             SetCurrentValue(IsEnabledProperty, Command?.CanExecute(CommandParameter) ?? true);

src/Avalonia.FreeDesktop/DBusMenuExporter.cs

@@ -243,6 +243,13 @@ private int GetId(NativeMenuItemBase item)
                             return new DBusVariantItem("b", new DBusBoolItem(false));
                         return null;
                     }
+
+                    if (name == "visible") {
+                        if (!item.IsVisible)
+                            return new DBusVariantItem("b", new DBusBoolItem(false));
+                        return new DBusVariantItem("b", new DBusBoolItem(true));
+                    }
+
                     if (name == "shortcut")
                     {
                         if (item.Gesture is null)

src/Avalonia.Native/IAvnMenuItem.cs

@@ -40,6 +40,7 @@ private void UpdateTitle(string title)
 
         private void UpdateToolTip(string toolTip) => SetToolTip(toolTip ?? "");
 
+        private void UpdateIsVisible(bool isVisible) => SetIsVisible(isVisible.AsComBool());
         private void UpdateIsChecked(bool isChecked) => SetIsChecked(isChecked.AsComBool());
 
         private void UpdateToggleType(NativeMenuItemToggleType toggleType)
@@ -121,6 +122,8 @@ internal void Initialize(NativeMenuItemBase nativeMenuItem)
 
                 UpdateIsChecked(item.IsChecked);
 
+                UpdateIsVisible(item.IsVisible);
+
                 _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.HeaderProperty)
                     .Subscribe(x => UpdateTitle(x)));
 
@@ -139,6 +142,9 @@ internal void Initialize(NativeMenuItemBase nativeMenuItem)
                 _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.IsCheckedProperty)
                     .Subscribe(x => UpdateIsChecked(x)));
 
+                _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.IsVisibleProperty)
+                    .Subscribe(x => UpdateIsVisible(x)));
+
                 _propertyDisposables.Add(ManagedMenuItem.GetObservable(NativeMenuItem.IconProperty)
                     .Subscribe(x => UpdateIcon(x)));
             }

src/Avalonia.Native/avn.idl

@@ -1026,6 +1026,7 @@ interface IAvnMenuItem : IUnknown
      HRESULT SetGesture(AvnKey key, AvnInputModifiers modifiers);
      HRESULT SetAction(IAvnPredicateCallback* predicate, IAvnActionCallback* callback);
      HRESULT SetIsChecked(bool isChecked);
+     HRESULT SetIsVisible(bool isVisible);
      HRESULT SetToggleType(AvnMenuItemToggleType toggleType);
      HRESULT SetIcon(void* data, size_t length);
 }