Allow excluding windows from being closed via Esc

Add a "pin" function to ingame windows, toggleable by clicking the shade
(aka. minimize) button while holding shift.
Pinned windows will be excluded from being closed by the window manager
when hitting the escape key.

Author: falbrechtskirchinger

libs/s25main/WindowManager.cpp

@@ -135,8 +135,8 @@ void WindowManager::RelayKeyboardMessage(KeyboardMsgHandler msg, const KeyEvent&
     if(ke.kt == KeyType::Escape || (ke.c == 'w' && ke.alt))
     {
         // Find one which isn't yet marked for closing so multiple ESC in between draw calls can close multiple windows
-        const auto itActiveWnd =
-          std::find_if(windows.rbegin(), windows.rend(), [](const auto& wnd) { return !wnd->ShouldBeClosed(); });
+        const auto itActiveWnd = std::find_if(
+          windows.rbegin(), windows.rend(), [](const auto& wnd) { return !wnd->ShouldBeClosed() && !wnd->IsPinned(); });
         if(itActiveWnd != windows.rend() && (*itActiveWnd)->getCloseBehavior() != CloseBehavior::Custom)
             (*itActiveWnd)->Close();
     } else if(!CALL_MEMBER_FN(*windows.back(), msg)(ke)) // send to active window

libs/s25main/ingameWindows/IngameWindow.cpp

@@ -15,6 +15,7 @@
 #include "ogl/glArchivItem_Bitmap.h"
 #include "ogl/glFont.h"
 #include "gameData/const_gui_ids.h"
+#include "s25util/colors.h"
 #include "s25util/error.h"
 #include <algorithm>
 #include <utility>
@@ -180,8 +181,15 @@ void IngameWindow::MouseLeftUp(const MouseCoords& mc)
                 Close();
             else
             {
-                SetMinimized(!IsMinimized());
-                LOADER.GetSoundN("sound", 113)->Play(255, false);
+                if(VIDEODRIVER.GetModKeyState().shift)
+                {
+                    SetPinned(!IsPinned());
+                    LOADER.GetSoundN("sound", 111)->Play(255, false);
+                } else
+                {
+                    SetMinimized(!IsMinimized());
+                    LOADER.GetSoundN("sound", 113)->Play(255, false);
+                }
             }
         }
     }
@@ -256,7 +264,13 @@ void IngameWindow::Draw_()
     if(closeBehavior_ != CloseBehavior::Custom)
         LOADER.GetImageN("resource", ids[0][buttonState[0]])->DrawFull(GetPos());
     if(!IsModal())
+    {
         LOADER.GetImageN("resource", ids[1][buttonState[1]])->DrawFull(GetPos() + DrawPoint(GetSize().x - 16, 0));
+        if(IsPinned())
+            LOADER.GetImageN("resource", ids[1][ButtonState::Hover])
+              ->DrawPart(Rect(GetPos() + DrawPoint(GetSize().x - 13, 3), Extent(10, 10)), DrawPoint(3, 3),
+                         SetAlpha(COLOR_RED, 0xFF / 2));
+    }
 
     // The title bar
     unsigned titleIndex;

libs/s25main/ingameWindows/IngameWindow.h

@@ -71,6 +71,9 @@ class IngameWindow : public Window
     /// ist das Fenster minimiert?
     bool IsMinimized() const { return isMinimized_; }
 
+    void SetPinned(bool pinned = true) { isPinned_ = pinned; }
+    bool IsPinned() const { return isPinned_; }
+
     CloseBehavior getCloseBehavior() const { return closeBehavior_; }
 
     /// Modal windows cannot be minimized, are always active and stay on top of non-modal ones
@@ -117,6 +120,7 @@ class IngameWindow : public Window
     bool isModal_;
     bool closeme;
     bool isMinimized_;
+    bool isPinned_ = false;
     bool isMoving;
     CloseBehavior closeBehavior_;
 };