Allow excluding windows from being closed via Esc

Add a "pin" function to in-game windows. The function replaces the shade
(aka. minimize) button and the window can instead be shaded by
double-clicking the title bar. Pinned windows are excluded from being
closed by the window manager when hitting the Escape key.

Author: falbrechtskirchinger

libs/s25main/WindowManager.cpp

@@ -132,11 +132,14 @@ void WindowManager::RelayKeyboardMessage(KeyboardMsgHandler msg, const KeyEvent&
         return; // No windows -> nothing to do
 
     // ESC or ALT+W closes the active window
-    if(ke.kt == KeyType::Escape || (ke.c == 'w' && ke.alt))
+    const auto escape = (ke.kt == KeyType::Escape);
+    if(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(); });
+        // ESC won't close pinned windows
+        const auto itActiveWnd = std::find_if(windows.rbegin(), windows.rend(), [escape](const auto& wnd) {
+            return !wnd->ShouldBeClosed() && !(escape && 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

@@ -34,8 +34,8 @@ constexpr Extent IngameWindow::ButtonSize;
 IngameWindow::IngameWindow(unsigned id, const DrawPoint& pos, const Extent& size, std::string title,
                            glArchivItem_Bitmap* background, bool modal, CloseBehavior closeBehavior, Window* parent)
     : Window(parent, id, pos, size), title_(std::move(title)), background(background), lastMousePos(0, 0),
-      isModal_(modal), closeme(false), isMinimized_(false), isMoving(false), closeBehavior_(closeBehavior),
-      buttonStates_({ButtonState::Up, ButtonState::Up})
+      isModal_(modal), closeme(false), isPinned_(false), isMinimized_(false), isMoving(false),
+      closeBehavior_(closeBehavior), buttonStates_({ButtonState::Up, ButtonState::Up, ButtonState::Up})
 {
     contentOffset.x = LOADER.GetImageN("resource", 38)->getWidth();     // left border
     contentOffset.y = LOADER.GetImageN("resource", 42)->getHeight();    // title bar
@@ -168,14 +168,31 @@ void IngameWindow::MouseLeftUp(const MouseCoords& mc)
         buttonStates_[id] = ButtonState::Up;
 
         if((id == IwButtonId::Close && closeBehavior_ == CloseBehavior::Custom) // no close button
-           || (id != IwButtonId::Close && isModal_))                            // modal windows cannot be minimized
+           || (id != IwButtonId::Close && isModal_)) // modal windows cannot be pinned or minimized
+            continue;
+
+        if(IsPointInRect(mc.GetPos(), GetButtonBounds(id)))
         {
             switch(id)
             {
                 case IwButtonId::Close: Close(); break;
-                case IwButtonId::Minimize:
-                    SetMinimized(!IsMinimized());
-                    LOADER.GetSoundN("sound", 113)->Play(255, false);
+                case IwButtonId::Title:
+                    if(SETTINGS.interface.enableWindowPinning && mc.dbl_click)
+                    {
+                        SetMinimized(!IsMinimized());
+                        LOADER.GetSoundN("sound", 113)->Play(255, false);
+                    }
+                    break;
+                case IwButtonId::PinOrMinimize:
+                    if(SETTINGS.interface.enableWindowPinning)
+                    {
+                        SetPinned(!IsPinned());
+                        LOADER.GetSoundN("sound", 111)->Play(255, false);
+                    } else
+                    {
+                        SetMinimized(!IsMinimized());
+                        LOADER.GetSoundN("sound", 113)->Play(255, false);
+                    }
                     break;
             }
         }
@@ -248,11 +265,25 @@ void IngameWindow::Draw_()
     using ButtonStateResIds = helpers::EnumArray<uint16_t, ButtonState>;
     constexpr ButtonStateResIds closeButtonResIds = {47, 55, 51};
     constexpr ButtonStateResIds minimizeButtonResIds = {48, 56, 52};
+    constexpr ButtonStateResIds pinButtonBaseResIds = {47, 47, 51};
+    constexpr ButtonStateResIds pinButtonOverlayResIds = {0, 1, 2};
+    constexpr ButtonStateResIds unpinButtonOverlayResIds = {3, 4, 5};
     if(closeBehavior_ != CloseBehavior::Custom)
         LOADER.GetImageN("resource", closeButtonResIds[buttonStates_[IwButtonId::Close]])->DrawFull(GetPos());
     if(!IsModal())
-        LOADER.GetImageN("resource", minimizeButtonResIds[buttonStates_[IwButtonId::Minimize]])
-          ->DrawFull(GetButtonBounds(IwButtonId::Minimize));
+    {
+        const auto buttonState = buttonStates_[IwButtonId::PinOrMinimize];
+        const auto bounds = GetButtonBounds(IwButtonId::PinOrMinimize);
+        if(SETTINGS.interface.enableWindowPinning)
+        {
+            LOADER.GetImageN("resource", pinButtonBaseResIds[buttonState])->DrawFull(bounds);
+            if(isPinned_)
+                LOADER.GetImageN("resource_new", unpinButtonOverlayResIds[buttonState])->DrawFull(bounds);
+            else
+                LOADER.GetImageN("resource_new", pinButtonOverlayResIds[buttonState])->DrawFull(bounds);
+        } else
+            LOADER.GetImageN("resource", minimizeButtonResIds[buttonState])->DrawFull(bounds);
+    }
 
     // The title bar
     unsigned titleIndex;
@@ -367,10 +398,15 @@ void IngameWindow::SaveOpenStatus(bool isOpen) const
 Rect IngameWindow::GetButtonBounds(IwButtonId id) const
 {
     auto pos = GetPos();
+    auto size = ButtonSize;
     switch(id)
     {
         case IwButtonId::Close: break;
-        case IwButtonId::Minimize: pos.x += GetSize().x - ButtonSize.x; break;
+        case IwButtonId::Title:
+            pos.x += TitleMargin;
+            size.x = GetSize().x - TitleMargin * 2;
+            break;
+        case IwButtonId::PinOrMinimize: pos.x += GetSize().x - ButtonSize.x; break;
     }
-    return Rect(pos, ButtonSize);
+    return Rect(pos, size);
 }

libs/s25main/ingameWindows/IngameWindow.h

@@ -28,11 +28,12 @@ enum CloseBehavior
 enum class IwButtonId : unsigned short
 {
     Close,
-    Minimize
+    Title, /// Pseudo-button to respond to double-clicks on the title bar
+    PinOrMinimize
 };
 constexpr auto maxEnumValue(IwButtonId)
 {
-    return IwButtonId::Minimize;
+    return IwButtonId::PinOrMinimize;
 }
 
 class IngameWindow : public Window
@@ -82,6 +83,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
@@ -125,6 +129,7 @@ class IngameWindow : public Window
 
     bool isModal_;
     bool closeme;
+    bool isPinned_;
     bool isMinimized_;
     bool isMoving;
     CloseBehavior closeBehavior_;