SFML backend no longer uses sf::Keyboard::isKeyPressed to check modif…

…ier keys

changelog.md

@@ -9,6 +9,7 @@ TGUI 1.5 (TBD)
 - Scrollbar::setSize no longer affects orientation once setOrientation is called
 - Opacity of ScrollablePanel wasn't applied to its scrollbars
 - Setting opacity of SeparatorLine had no effect
+- SFML backend no longer uses sf::Keyboard::isKeyPressed to check modifier keys
 
 
 TGUI 1.4.1  (20 July 2024)

gui-builder/src/Form.cpp

@@ -1350,12 +1350,13 @@ std::vector<std::pair<tgui::Vector2f, tgui::Vector2f>> Form::getAlignmentLines()
     const auto controlModifier = tgui::Event::KeyModifier::Control;
 #endif
 
+    const auto selectedWidget = m_selectedWidget->ptr;
+    const auto* gui = selectedWidget->getParentGui();
     if (!m_draggingWidget && !m_draggingSelectionSquare
-     && !tgui::getBackend()->isKeyboardModifierPressed(controlModifier)
-     && !tgui::getBackend()->isKeyboardModifierPressed(tgui::Event::KeyModifier::Shift))
+     && !gui->isKeyboardModifierPressed(controlModifier)
+     && !gui->isKeyboardModifierPressed(tgui::Event::KeyModifier::Shift))
         return lines;
 
-    const auto selectedWidget = m_selectedWidget->ptr;
     const tgui::Vector2f selectedTopLeft = selectedWidget->getAbsolutePosition();
     const tgui::Vector2f selectedBottomRight = selectedWidget->getAbsolutePosition() + selectedWidget->getSize();
     const auto widgets = selectedWidget->getParent()->getWidgets();

include/TGUI/Backend/Window/Backend.hpp

@@ -226,7 +226,7 @@ TGUI_MODULE_EXPORT namespace tgui
         ///
         /// @return Whether queries modifier key is being pressed
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-        TGUI_NODISCARD virtual bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) = 0;
+        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD virtual bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) = 0;
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes the contents of the clipboard

include/TGUI/Backend/Window/BackendGui.hpp

@@ -598,6 +598,15 @@ TGUI_MODULE_EXPORT namespace tgui
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         virtual void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos);
 
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        /// @brief Checks the state for one of the modifier keys
+        ///
+        /// @param modifierKey  The modifier key of which the state is being queried
+        ///
+        /// @return Whether queries modifier key is being pressed
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        TGUI_NODISCARD virtual bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const; // TGUI_NEXT: Pure virtual
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes whether using the arrow keys can be used to navigate between widgets
         ///

include/TGUI/Backend/Window/GLFW/BackendGLFW.hpp

@@ -104,7 +104,7 @@ TGUI_MODULE_EXPORT namespace tgui
         ///
         /// @return Whether queries modifier key is being pressed
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
+        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes the contents of the clipboard
@@ -152,7 +152,7 @@ TGUI_MODULE_EXPORT namespace tgui
             Cursor::Type mouseCursor = Cursor::Type::Arrow;
         };
 
-        std::unordered_map<BackendGui*, GuiResources> m_guiResources;
+        std::unordered_map<const BackendGui*, GuiResources> m_guiResources;
         std::unordered_map<Cursor::Type, GLFWcursor*> m_mouseCursors;
     };
 

include/TGUI/Backend/Window/GLFW/BackendGuiGLFW.hpp

@@ -239,6 +239,15 @@ TGUI_MODULE_EXPORT namespace tgui
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
 
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        /// @brief Checks the state for one of the modifier keys
+        ///
+        /// @param modifierKey  The modifier key of which the state is being queried
+        ///
+        /// @return Whether queries modifier key is being pressed
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     protected:
 

include/TGUI/Backend/Window/Raylib/BackendGuiRaylib.hpp

@@ -153,6 +153,15 @@ TGUI_MODULE_EXPORT namespace tgui
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
 
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        /// @brief Checks the state for one of the modifier keys
+        ///
+        /// @param modifierKey  The modifier key of which the state is being queried
+        ///
+        /// @return Whether queries modifier key is being pressed
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Breaks out of the main loop that is implemented inside the mainLoop function
         ///

include/TGUI/Backend/Window/Raylib/BackendRaylib.hpp

@@ -88,7 +88,7 @@ TGUI_MODULE_EXPORT namespace tgui
         ///
         /// @return Whether queries modifier key is being pressed
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
+        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes the contents of the clipboard

include/TGUI/Backend/Window/SDL/BackendGuiSDL.hpp

@@ -140,6 +140,15 @@ TGUI_MODULE_EXPORT namespace tgui
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
 
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        /// @brief Checks the state for one of the modifier keys
+        ///
+        /// @param modifierKey  The modifier key of which the state is being queried
+        ///
+        /// @return Whether queries modifier key is being pressed
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     protected:
 

include/TGUI/Backend/Window/SDL/BackendSDL.hpp

@@ -117,7 +117,7 @@ TGUI_MODULE_EXPORT namespace tgui
         ///
         /// @return Whether queries modifier key is being pressed
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
+        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes the contents of the clipboard
@@ -172,7 +172,7 @@ TGUI_MODULE_EXPORT namespace tgui
             Cursor::Type mouseCursor = Cursor::Type::Arrow;
         };
 
-        std::unordered_map<BackendGui*, GuiResources> m_guiResources;
+        std::unordered_map<const BackendGui*, GuiResources> m_guiResources;
         std::unordered_map<Cursor::Type, SDL_Cursor*> m_mouseCursors;
 
 #if defined(TGUI_SYSTEM_LINUX) && defined(TGUI_USE_X11) && (SDL_MAJOR_VERSION < 3) && defined(SDL_VIDEO_DRIVER_X11)

include/TGUI/Backend/Window/SFML/BackendGuiSFML.hpp

@@ -171,6 +171,15 @@ TGUI_MODULE_EXPORT namespace tgui
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
 
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        /// @brief Checks the state for one of the modifier keys
+        ///
+        /// @param modifierKey  The modifier key of which the state is being queried
+        ///
+        /// @return Whether queries modifier key is being pressed
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     protected:
 
@@ -191,6 +200,11 @@ TGUI_MODULE_EXPORT namespace tgui
 
         sf::Window* m_window = nullptr;
 
+        bool m_modifierKeySystemPressed = false;
+        bool m_modifierKeyControlPressed = false;
+        bool m_modifierKeyShiftPressed = false;
+        bool m_modifierKeyAltPressed = false;
+
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     };
 }

include/TGUI/Backend/Window/SFML/BackendSFML.hpp

@@ -114,7 +114,7 @@ TGUI_MODULE_EXPORT namespace tgui
         ///
         /// @return Whether queries modifier key is being pressed
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-        TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
+        TGUI_DEPRECATED("Use gui.isKeyboardModifierPressed(modifierKey) instead") TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
         /// @brief Changes the contents of the clipboard
@@ -182,7 +182,7 @@ TGUI_MODULE_EXPORT namespace tgui
             Cursor::Type mouseCursor = Cursor::Type::Arrow;
         };
 
-        std::unordered_map<BackendGui*, GuiResources> m_guiResources;
+        std::unordered_map<const BackendGui*, GuiResources> m_guiResources;
         std::unordered_map<Cursor::Type, std::unique_ptr<sf::Cursor>> m_mouseCursors;
 
         static std::vector<std::unique_ptr<sf::Cursor>> m_leakedCursors;

include/TGUI/Keyboard.hpp

@@ -103,10 +103,19 @@ namespace tgui
         }
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-
-        TGUI_NODISCARD inline bool isShiftPressed()
+#ifndef TGUI_REMOVE_DEPRECATED_CODE
+        TGUI_DEPRECATED("Use isShiftPressed(gui) instead") TGUI_NODISCARD inline bool isShiftPressed()
         {
+            TGUI_IGNORE_DEPRECATED_WARNINGS_START
             return getBackend()->isKeyboardModifierPressed(Event::KeyModifier::Shift);
+            TGUI_IGNORE_DEPRECATED_WARNINGS_END
+        }
+#endif
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+        TGUI_NODISCARD inline bool isShiftPressed(const BackendGui* gui)
+        {
+            return gui->isKeyboardModifierPressed(Event::KeyModifier::Shift);
         }
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -130,13 +139,26 @@ namespace tgui
         }
 
         /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-
-        TGUI_NODISCARD inline bool isMultiselectModifierPressed()
+#ifndef TGUI_REMOVE_DEPRECATED_CODE
+        TGUI_DEPRECATED("Use isMultiselectModifierPressed(gui) instead") TGUI_NODISCARD inline bool isMultiselectModifierPressed()
         {
+            TGUI_IGNORE_DEPRECATED_WARNINGS_START
 #ifdef TGUI_SYSTEM_MACOS
             return getBackend()->isKeyboardModifierPressed(Event::KeyModifier::System);
 #else
             return getBackend()->isKeyboardModifierPressed(Event::KeyModifier::Control);
+#endif
+            TGUI_IGNORE_DEPRECATED_WARNINGS_END
+        }
+#endif
+        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+        TGUI_NODISCARD inline bool isMultiselectModifierPressed(const BackendGui* gui)
+        {
+#ifdef TGUI_SYSTEM_MACOS
+            return gui->isKeyboardModifierPressed(Event::KeyModifier::System);
+#else
+            return gui->isKeyboardModifierPressed(Event::KeyModifier::Control);
 #endif
         }
 

src/Backend/Window/BackendGui.cpp

@@ -668,6 +668,15 @@ namespace tgui
 
     /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+    bool BackendGui::isKeyboardModifierPressed(Event::KeyModifier modifierKey) const
+    {
+TGUI_IGNORE_DEPRECATED_WARNINGS_START
+        return getBackend()->isKeyboardModifierPressed(modifierKey);
+TGUI_IGNORE_DEPRECATED_WARNINGS_END
+    }
+
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
     void BackendGui::setKeyboardNavigationEnabled(bool enabled)
     {
         m_keyboardNavigationEnabled = enabled;

src/Backend/Window/GLFW/BackendGLFW.cpp

@@ -104,7 +104,8 @@ namespace tgui
 
     bool BackendGLFW::isKeyboardModifierPressed(Event::KeyModifier modifierKey)
     {
-        /// TODO: If there are multiple windows then we need to do this on the focused window
+        // This code may be wrong when there are multiple windows. This function has been deprecated in favor of the
+        // function in the gui object, which calls glfwGetKey on the attached window instead of an arbitrarily one.
         GLFWwindow* window = getAnyWindow();
         if (!window)
             return false;

src/Backend/Window/GLFW/BackendGuiGLFW.cpp

@@ -474,6 +474,26 @@ namespace tgui
 #endif
     /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+    bool BackendGuiGLFW::isKeyboardModifierPressed(Event::KeyModifier modifierKey) const
+    {
+        switch (modifierKey)
+        {
+        case Event::KeyModifier::System:
+            return (glfwGetKey(m_window, GLFW_KEY_LEFT_SUPER) == GLFW_PRESS) || (glfwGetKey(m_window, GLFW_KEY_RIGHT_SUPER) == GLFW_PRESS);
+        case Event::KeyModifier::Control:
+            return (glfwGetKey(m_window, GLFW_KEY_LEFT_CONTROL) == GLFW_PRESS) || (glfwGetKey(m_window, GLFW_KEY_RIGHT_CONTROL) == GLFW_PRESS);
+        case Event::KeyModifier::Shift:
+            return (glfwGetKey(m_window, GLFW_KEY_LEFT_SHIFT) == GLFW_PRESS) || (glfwGetKey(m_window, GLFW_KEY_RIGHT_SHIFT) == GLFW_PRESS);
+        case Event::KeyModifier::Alt:
+            return (glfwGetKey(m_window, GLFW_KEY_LEFT_ALT) == GLFW_PRESS) || (glfwGetKey(m_window, GLFW_KEY_RIGHT_ALT) == GLFW_PRESS);
+        }
+
+        TGUI_ASSERT(false, "BackendGuiGLFW::isKeyboardModifierPressed called with an invalid value");
+        return false;
+    }
+
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
     void BackendGuiGLFW::setGuiWindow(GLFWwindow* window)
     {
         TGUI_ASSERT(std::dynamic_pointer_cast<BackendGLFW>(getBackend()), "BackendGuiGLFW requires system backend of type BackendGLFW");

src/Backend/Window/Raylib/BackendGuiRaylib.cpp

@@ -276,6 +276,26 @@ namespace tgui
 
     /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+    bool BackendGuiRaylib::isKeyboardModifierPressed(Event::KeyModifier modifierKey) const
+    {
+        switch (modifierKey)
+        {
+        case Event::KeyModifier::System:
+            return IsKeyDown(KEY_LEFT_SUPER) || IsKeyDown(KEY_RIGHT_SUPER);
+        case Event::KeyModifier::Control:
+            return IsKeyDown(KEY_LEFT_CONTROL) || IsKeyDown(KEY_RIGHT_CONTROL);
+        case Event::KeyModifier::Shift:
+            return IsKeyDown(KEY_LEFT_SHIFT) || IsKeyDown(KEY_RIGHT_SHIFT);
+        case Event::KeyModifier::Alt:
+            return IsKeyDown(KEY_LEFT_ALT) || IsKeyDown(KEY_RIGHT_ALT);
+        }
+
+        TGUI_ASSERT(false, "BackendGuiRaylib::isKeyboardModifierPressed called with an invalid value");
+        return false;
+    }
+
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
     void BackendGuiRaylib::endMainLoop()
     {
         m_endMainLoop = true;

src/Backend/Window/SDL/BackendGuiSDL.cpp

@@ -705,6 +705,27 @@ namespace tgui
 
     /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
+    bool BackendGuiSDL::isKeyboardModifierPressed(Event::KeyModifier modifierKey) const
+    {
+        const SDL_Keymod pressedModifiers = SDL_GetModState();
+        switch (modifierKey)
+        {
+        case Event::KeyModifier::System:
+            return (pressedModifiers & SDL_KMOD_GUI) != 0;
+        case Event::KeyModifier::Control:
+            return (pressedModifiers & SDL_KMOD_CTRL) != 0;
+        case Event::KeyModifier::Shift:
+            return (pressedModifiers & SDL_KMOD_SHIFT) != 0;
+        case Event::KeyModifier::Alt:
+            return (pressedModifiers & SDL_KMOD_ALT) != 0;
+        }
+
+        TGUI_ASSERT(false, "BackendGuiSDL::isKeyboardModifierPressed called with an invalid value");
+        return false;
+    }
+
+    /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
     void BackendGuiSDL::setGuiWindow(SDL_Window* window)
     {
         TGUI_ASSERT(std::dynamic_pointer_cast<BackendSDL>(getBackend()), "BackendGuiSDL requires system backend of type BackendSDL");