Merge pull request #8211 from AvaloniaUI/fixes/osx-dialog-keep-on-top-when-deactivated

[OSX] dialogs stay ontop of main window when another app is displayed.

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

@@ -3,8 +3,6 @@
 // Copyright (c) 2022 Avalonia. All rights reserved.
 //
 
-#pragma once
-
 #define IS_NSPANEL
 
 #include "AvnWindow.mm"

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

@@ -222,7 +222,7 @@
 
 - (void)mouseEvent:(NSEvent *)event withType:(AvnRawMouseEventType) type
 {
-    bool triggerInputWhenDisabled = type != Move;
+    bool triggerInputWhenDisabled = type != Move && type != LeaveWindow;
 
     if([self ignoreUserInput: triggerInputWhenDisabled])
     {
@@ -709,4 +709,4 @@
     return [[self accessibilityChild] accessibilityFocusedUIElement];
 }
 
-@end
+@end

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

@@ -68,7 +68,7 @@
     }
 }
 
-- (void)performClose:(id)sender
+- (void)performClose:(id _Nullable )sender
 {
     if([[self delegate] respondsToSelector:@selector(windowShouldClose:)])
     {
@@ -147,7 +147,7 @@
     }
 }
 
--(void) applyMenu:(AvnMenu *)menu
+-(void) applyMenu:(AvnMenu *_Nullable)menu
 {
     if(menu == nullptr)
     {
@@ -157,7 +157,7 @@
     _menu = menu;
 }
 
--(CLASS_NAME*)  initWithParent: (WindowBaseImpl*) parent contentRect: (NSRect)contentRect styleMask: (NSWindowStyleMask)styleMask;
+-(CLASS_NAME*_Nonnull)  initWithParent: (WindowBaseImpl*_Nonnull) parent contentRect: (NSRect)contentRect styleMask: (NSWindowStyleMask)styleMask;
 {
     // https://jameshfisher.com/2020/07/10/why-is-the-contentrect-of-my-nswindow-ignored/
     // create nswindow with specific contentRect, otherwise we wont be able to resize the window
@@ -183,7 +183,7 @@
     return self;
 }
 
-- (BOOL)windowShouldClose:(NSWindow *)sender
+- (BOOL)windowShouldClose:(NSWindow *_Nonnull)sender
 {
     auto window = dynamic_cast<WindowImpl*>(_parent.getRaw());
 
@@ -195,21 +195,28 @@
     return true;
 }
 
-- (void)windowDidChangeBackingProperties:(NSNotification *)notification
+- (void)windowDidChangeBackingProperties:(NSNotification *_Nonnull)notification
 {
     [self backingScaleFactor];
 }
 
 
 
-- (void)windowWillClose:(NSNotification *)notification
+- (void)windowWillClose:(NSNotification *_Nonnull)notification
 {
     _closed = true;
     if(_parent)
     {
         ComPtr<WindowBaseImpl> parent = _parent;
         _parent = NULL;
-        [self restoreParentWindow];
+        
+        auto window = dynamic_cast<WindowImpl*>(parent.getRaw());
+        
+        if(window != nullptr)
+        {
+            window->SetParent(nullptr);
+        }
+        
         parent->BaseEvents->Closed();
         [parent->View onClosed];
     }
@@ -220,17 +227,11 @@
     if(_canBecomeKeyWindow)
     {
         // If the window has a child window being shown as a dialog then don't allow it to become the key window.
-        for(NSWindow* uch in [self childWindows])
+        auto parent = dynamic_cast<WindowImpl*>(_parent.getRaw());
+        
+        if(parent != nullptr)
         {
-            if (![uch conformsToProtocol:@protocol(AvnWindowProtocol)])
-            {
-                continue;
-            }
-
-            id <AvnWindowProtocol> ch = (id <AvnWindowProtocol>) uch;
-
-            if(ch.isDialog)
-                return false;
+            return parent->CanBecomeKeyWindow();
         }
 
         return true;
@@ -273,17 +274,12 @@
     [super becomeKeyWindow];
 }
 
--(void) restoreParentWindow;
+- (void)windowDidBecomeKey:(NSNotification *_Nonnull)notification
 {
-    auto parent = [self parentWindow];
-
-    if(parent != nil)
-    {
-        [parent removeChildWindow:self];
-    }
+    _parent->BringToFront();
 }
 
-- (void)windowDidMiniaturize:(NSNotification *)notification
+- (void)windowDidMiniaturize:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -293,7 +289,7 @@
     }
 }
 
-- (void)windowDidDeminiaturize:(NSNotification *)notification
+- (void)windowDidDeminiaturize:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -303,7 +299,7 @@
     }
 }
 
-- (void)windowDidResize:(NSNotification *)notification
+- (void)windowDidResize:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -313,7 +309,7 @@
     }
 }
 
-- (void)windowWillExitFullScreen:(NSNotification *)notification
+- (void)windowWillExitFullScreen:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -323,7 +319,7 @@
     }
 }
 
-- (void)windowDidExitFullScreen:(NSNotification *)notification
+- (void)windowDidExitFullScreen:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -346,7 +342,7 @@
     }
 }
 
-- (void)windowWillEnterFullScreen:(NSNotification *)notification
+- (void)windowWillEnterFullScreen:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -356,7 +352,7 @@
     }
 }
 
-- (void)windowDidEnterFullScreen:(NSNotification *)notification
+- (void)windowDidEnterFullScreen:(NSNotification *_Nonnull)notification
 {
     auto parent = dynamic_cast<IWindowStateChanged*>(_parent.operator->());
 
@@ -367,7 +363,7 @@
     }
 }
 
-- (BOOL)windowShouldZoom:(NSWindow *)window toFrame:(NSRect)newFrame
+- (BOOL)windowShouldZoom:(NSWindow *_Nonnull)window toFrame:(NSRect)newFrame
 {
     return true;
 }
@@ -378,11 +374,13 @@
         _parent->BaseEvents->Deactivated();
 
     [self showAppMenuOnly];
+    
+    [self invalidateShadow];
 
     [super resignKeyWindow];
 }
 
-- (void)windowDidMove:(NSNotification *)notification
+- (void)windowDidMove:(NSNotification *_Nonnull)notification
 {
     AvnPoint position;
 
@@ -414,7 +412,7 @@
     return pt;
 }
 
-- (void)sendEvent:(NSEvent *)event
+- (void)sendEvent:(NSEvent *_Nonnull)event
 {
     [super sendEvent:event];
 
@@ -437,8 +435,10 @@
 
                     _parent->BaseEvents->RawMouseEvent(NonClientLeftButtonDown, static_cast<uint32>([event timestamp] * 1000), AvnInputModifiersNone, point, delta);
                 }
+                
+                _parent->BringToFront();
             }
-                break;
+            break;
 
             case NSEventTypeMouseEntered:
             {

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

@@ -11,7 +11,7 @@
 struct INSWindowHolder
 {
     virtual NSWindow* _Nonnull GetNSWindow () = 0;
-    virtual NSView* _Nonnull GetNSView () = 0;
+    virtual AvnView* _Nonnull GetNSView () = 0;
 };
 
 #endif //AVALONIA_NATIVE_OSX_INSWINDOWHOLDER_H

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

@@ -26,7 +26,7 @@ BEGIN_INTERFACE_MAP()
 
     virtual ~WindowBaseImpl();
 
-    WindowBaseImpl(IAvnWindowBaseEvents *events, IAvnGlContext *gl);
+    WindowBaseImpl(IAvnWindowBaseEvents *events, IAvnGlContext *gl, bool usePanel = false);
 
     virtual HRESULT ObtainNSWindowHandle(void **ret) override;
 
@@ -38,7 +38,7 @@ BEGIN_INTERFACE_MAP()
 
     virtual NSWindow *GetNSWindow() override;
 
-    virtual NSView *GetNSView() override;
+    virtual AvnView *GetNSView() override;
 
     virtual HRESULT Show(bool activate, bool isDialog) override;
 
@@ -99,6 +99,8 @@ BEGIN_INTERFACE_MAP()
     virtual bool IsDialog();
 
     id<AvnWindowProtocol> GetWindowProtocol ();
+                           
+    virtual void BringToFront ();
 
 protected:
     virtual NSWindowStyleMask GetStyle();

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

@@ -21,7 +21,7 @@ WindowBaseImpl::~WindowBaseImpl() {
     Window = nullptr;
 }
 
-WindowBaseImpl::WindowBaseImpl(IAvnWindowBaseEvents *events, IAvnGlContext *gl) {
+WindowBaseImpl::WindowBaseImpl(IAvnWindowBaseEvents *events, IAvnGlContext *gl, bool usePanel) {
     _shown = false;
     _inResize = false;
     BaseEvents = events;
@@ -36,8 +36,10 @@ WindowBaseImpl::WindowBaseImpl(IAvnWindowBaseEvents *events, IAvnGlContext *gl)
     lastMaxSize = NSSize { CGFLOAT_MAX, CGFLOAT_MAX};
     lastMinSize = NSSize { 0, 0 };
 
-    Window = nullptr;
     lastMenu = nullptr;
+    
+    CreateNSWindow(usePanel);
+    InitialiseNSWindow();
 }
 
 HRESULT WindowBaseImpl::ObtainNSViewHandle(void **ret) {
@@ -68,7 +70,7 @@ NSWindow *WindowBaseImpl::GetNSWindow() {
     return Window;
 }
 
-NSView *WindowBaseImpl::GetNSView() {
+AvnView *WindowBaseImpl::GetNSView() {
     return View;
 }
 
@@ -88,7 +90,6 @@ HRESULT WindowBaseImpl::Show(bool activate, bool isDialog) {
     START_COM_CALL;
 
     @autoreleasepool {
-        CreateNSWindow(isDialog);
         InitialiseNSWindow();
 
         if(hasPosition)
@@ -143,8 +144,6 @@ HRESULT WindowBaseImpl::Hide() {
     @autoreleasepool {
         if (Window != nullptr) {
             [Window orderOut:Window];
-
-            [GetWindowProtocol() restoreParentWindow];
         }
 
         return S_OK;
@@ -558,6 +557,8 @@ void WindowBaseImpl::CreateNSWindow(bool isDialog) {
             CleanNSWindow();
 
             Window = [[AvnPanel alloc] initWithParent:this contentRect:NSRect{0, 0, lastSize} styleMask:GetStyle()];
+            
+            [Window setHidesOnDeactivate:false];
         }
     } else {
         if (![Window isKindOfClass:[AvnWindow class]]) {
@@ -585,6 +586,7 @@ void WindowBaseImpl::InitialiseNSWindow() {
 
         [Window setOpaque:false];
         
+        [Window setHasShadow:true];
         [Window invalidateShadow];
 
         if (lastMenu != nullptr) {
@@ -608,6 +610,11 @@ id <AvnWindowProtocol> WindowBaseImpl::GetWindowProtocol() {
     return (id <AvnWindowProtocol>) Window;
 }
 
+void WindowBaseImpl::BringToFront()
+{
+    // do nothing.
+}
+
 extern IAvnWindow* CreateAvnWindow(IAvnWindowEvents*events, IAvnGlContext* gl)
 {
     @autoreleasepool

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

@@ -8,6 +8,7 @@
 
 #import "WindowBaseImpl.h"
 #include "IWindowStateChanged.h"
+#include <list>
 
 class WindowImpl : public virtual WindowBaseImpl, public virtual IAvnWindow, public IWindowStateChanged
 {
@@ -22,6 +23,8 @@ private:
     bool _transitioningWindowState;
     bool _isClientAreaExtended;
     bool _isDialog;
+    WindowImpl* _parent;
+    std::list<WindowImpl*> _children;
     AvnExtendClientAreaChromeHints _extendClientHints;
 
     FORWARD_IUNKNOWN()
@@ -90,6 +93,10 @@ BEGIN_INTERFACE_MAP()
     virtual bool IsDialog() override;
     
     virtual void OnInitialiseNSWindow() override;
+    
+    virtual void BringToFront () override;
+    
+    bool CanBecomeKeyWindow ();
 
 protected:
     virtual NSWindowStyleMask GetStyle() override;

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

@@ -10,6 +10,7 @@
 #include "WindowProtocol.h"
 
 WindowImpl::WindowImpl(IAvnWindowEvents *events, IAvnGlContext *gl) : WindowBaseImpl(events, gl) {
+    _children = std::list<WindowImpl*>();
     _isClientAreaExtended = false;
     _extendClientHints = AvnDefaultChrome;
     _fullScreenActive = false;
@@ -20,6 +21,7 @@ WindowImpl::WindowImpl(IAvnWindowEvents *events, IAvnGlContext *gl) : WindowBase
     _lastWindowState = Normal;
     _actualWindowState = Normal;
     _lastTitle = @"";
+    _parent = nullptr;
     WindowEvents = events;
 }
 
@@ -61,6 +63,11 @@ void WindowImpl::OnInitialiseNSWindow(){
         [GetWindowProtocol() setIsExtended:true];
         SetExtendClientArea(true);
     }
+    
+    if(_parent != nullptr)
+    {
+        SetParent(_parent);
+    }
 }
 
 HRESULT WindowImpl::Show(bool activate, bool isDialog) {
@@ -90,26 +97,66 @@ HRESULT WindowImpl::SetParent(IAvnWindow *parent) {
     START_COM_CALL;
 
     @autoreleasepool {
-        if (parent == nullptr)
-            return E_POINTER;
+        if(_parent != nullptr)
+        {
+            _parent->_children.remove(this);
+            auto parent = _parent;
+            
+            dispatch_async(dispatch_get_main_queue(), ^{
+                parent->BringToFront();
+            });
+        }
 
         auto cparent = dynamic_cast<WindowImpl *>(parent);
-        if (cparent == nullptr)
-            return E_INVALIDARG;
-
-        // If one tries to show a child window with a minimized parent window, then the parent window will be
-        // restored but macOS isn't kind enough to *tell* us that, so the window will be left in a non-interactive
-        // state. Detect this and explicitly restore the parent window ourselves to avoid this situation.
-        if (cparent->WindowState() == Minimized)
-            cparent->SetWindowState(Normal);
+        
+        _parent = cparent;
+        
+        if(_parent != nullptr && Window != nullptr){
+            // If one tries to show a child window with a minimized parent window, then the parent window will be
+            // restored but macOS isn't kind enough to *tell* us that, so the window will be left in a non-interactive
+            // state. Detect this and explicitly restore the parent window ourselves to avoid this situation.
+            if (cparent->WindowState() == Minimized)
+                cparent->SetWindowState(Normal);
+
+            [Window setCollectionBehavior:NSWindowCollectionBehaviorFullScreenAuxiliary];
+                
+            cparent->_children.push_back(this);
+                
+            UpdateStyle();
+        }
 
-        [Window setCollectionBehavior:NSWindowCollectionBehaviorFullScreenAuxiliary];
-        [cparent->Window addChildWindow:Window ordered:NSWindowAbove];
+        return S_OK;
+    }
+}
 
-        UpdateStyle();
+void WindowImpl::BringToFront()
+{
+    if(IsDialog())
+    {
+        Activate();
+    }
+    else
+    {
+        [Window orderFront:nullptr];
+    }
+    
+    for(auto iterator = _children.begin(); iterator != _children.end(); iterator++)
+    {
+        (*iterator)->BringToFront();
+    }
+}
 
-        return S_OK;
+bool WindowImpl::CanBecomeKeyWindow()
+{
+    for(auto iterator = _children.begin(); iterator != _children.end(); iterator++)
+    {
+        if((*iterator)->IsDialog())
+        {
+            return false;
+        }
     }
+    
+    return true;
 }
 
 void WindowImpl::StartStateTransition() {
@@ -523,7 +570,7 @@ bool WindowImpl::IsDialog() {
 }
 
 NSWindowStyleMask WindowImpl::GetStyle() {
-    unsigned long s = this->_isDialog ? NSWindowStyleMaskDocModalWindow : NSWindowStyleMaskBorderless;
+    unsigned long s = NSWindowStyleMaskBorderless;
 
     switch (_decorations) {
         case SystemDecorationsNone:
@@ -535,7 +582,7 @@ NSWindowStyleMask WindowImpl::GetStyle() {
             break;
 
         case SystemDecorationsFull:
-            s = s | NSWindowStyleMaskTitled | NSWindowStyleMaskClosable | NSWindowStyleMaskBorderless;
+            s = s | NSWindowStyleMaskTitled | NSWindowStyleMaskClosable;
 
             if (_canResize) {
                 s = s | NSWindowStyleMaskResizable;
@@ -543,7 +590,7 @@ NSWindowStyleMask WindowImpl::GetStyle() {
             break;
     }
 
-    if ([Window parentWindow] == nullptr) {
+    if (!IsDialog()) {
         s |= NSWindowStyleMaskMiniaturizable;
     }
 

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

@@ -11,7 +11,6 @@
 
 @protocol AvnWindowProtocol
 -(void) pollModalSession: (NSModalSession _Nonnull) session;
--(void) restoreParentWindow;
 -(bool) shouldTryToHandleEvents;
 -(void) setEnabled: (bool) enable;
 -(void) showAppMenuOnly;