diff options
Diffstat (limited to 'include/SFML/Window/Mouse.hpp')
| -rw-r--r-- | include/SFML/Window/Mouse.hpp | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/include/SFML/Window/Mouse.hpp b/include/SFML/Window/Mouse.hpp index 0d1e470..e2a55c4 100644 --- a/include/SFML/Window/Mouse.hpp +++ b/include/SFML/Window/Mouse.hpp @@ -1,7 +1,7 @@ //////////////////////////////////////////////////////////// // // SFML - Simple and Fast Multimedia Library -// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org) +// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org) // // This software is provided 'as-is', without any express or implied warranty. // In no event will the authors be held liable for any damages arising from the use of this software. @@ -34,7 +34,7 @@ namespace sf { -class Window; +class WindowBase; //////////////////////////////////////////////////////////// /// \brief Give access to the real-time state of the mouse @@ -50,13 +50,13 @@ public: //////////////////////////////////////////////////////////// enum Button { - Left, ///< The left mouse button - Right, ///< The right mouse button - Middle, ///< The middle (wheel) mouse button - XButton1, ///< The first extra mouse button - XButton2, ///< The second extra mouse button + Left, //!< The left mouse button + Right, //!< The right mouse button + Middle, //!< The middle (wheel) mouse button + XButton1, //!< The first extra mouse button + XButton2, //!< The second extra mouse button - ButtonCount ///< Keep last -- the total number of mouse buttons + ButtonCount //!< Keep last -- the total number of mouse buttons }; //////////////////////////////////////////////////////////// @@ -65,13 +65,16 @@ public: //////////////////////////////////////////////////////////// enum Wheel { - VerticalWheel, ///< The vertical mouse wheel - HorizontalWheel ///< The horizontal mouse wheel + VerticalWheel, //!< The vertical mouse wheel + HorizontalWheel //!< The horizontal mouse wheel }; //////////////////////////////////////////////////////////// /// \brief Check if a mouse button is pressed /// + /// \warning Checking the state of buttons Mouse::XButton1 and + /// Mouse::XButton2 is not supported on Linux with X11. + /// /// \param button Button to check /// /// \return True if the button is pressed, false otherwise @@ -101,7 +104,7 @@ public: /// \return Current position of the mouse /// //////////////////////////////////////////////////////////// - static Vector2i getPosition(const Window& relativeTo); + static Vector2i getPosition(const WindowBase& relativeTo); //////////////////////////////////////////////////////////// /// \brief Set the current position of the mouse in desktop coordinates @@ -124,7 +127,7 @@ public: /// \param relativeTo Reference window /// //////////////////////////////////////////////////////////// - static void setPosition(const Vector2i& position, const Window& relativeTo); + static void setPosition(const Vector2i& position, const WindowBase& relativeTo); }; } // namespace sf |