From 6a24eb5eec347af5bdcdd5a3c33753f34bd64771 Mon Sep 17 00:00:00 2001 From: Jan Haller Date: Sat, 3 May 2014 14:25:00 +0200 Subject: [PATCH] Slightly adapted window focus documentation --- include/SFML/Window/Window.hpp | 11 +++++------ src/SFML/Window/OSX/WindowImplCocoa.hpp | 2 +- src/SFML/Window/OSX/WindowImplDelegateProtocol.h | 2 +- src/SFML/Window/Unix/WindowImplX11.hpp | 2 +- src/SFML/Window/Win32/WindowImplWin32.hpp | 2 +- src/SFML/Window/WindowImpl.hpp | 2 +- 6 files changed, 10 insertions(+), 11 deletions(-) diff --git a/include/SFML/Window/Window.hpp b/include/SFML/Window/Window.hpp index 3a98971d2..0ba0477b9 100644 --- a/include/SFML/Window/Window.hpp +++ b/include/SFML/Window/Window.hpp @@ -417,28 +417,27 @@ public: /// foreground window /// /// At any given time, only one window may have the input focus - /// to receive input events such as keystrokes or mouse - /// events. + /// to receive input events such as keystrokes or mouse events. /// If a window requests focus, it only hints to the operating /// system, that it would like to be focused. The operating system - /// is free to deny the request. For example under Windows OS - /// windows are not allowed to steal focus. But the user - /// will be notified through a flashing taskbar button. + /// is free to deny the request. /// This is not to be confused with setActive(). /// /// \return True if operation was successful, false otherwise + /// \see hasFocus /// //////////////////////////////////////////////////////////// bool requestFocus(); //////////////////////////////////////////////////////////// - /// \brief Determine whether the window has the input focus + /// \brief Check whether the window has the input focus /// /// At any given time, only one window may have the input focus /// to receive input events such as keystrokes or most mouse /// events. /// /// \return True if window has focus, false otherwise + /// \see requestFocus /// //////////////////////////////////////////////////////////// bool hasFocus() const; diff --git a/src/SFML/Window/OSX/WindowImplCocoa.hpp b/src/SFML/Window/OSX/WindowImplCocoa.hpp index f65d63ed7..1dfc680f6 100644 --- a/src/SFML/Window/OSX/WindowImplCocoa.hpp +++ b/src/SFML/Window/OSX/WindowImplCocoa.hpp @@ -330,7 +330,7 @@ public: virtual bool requestFocus(); //////////////////////////////////////////////////////////// - /// \brief Determine whether the window has the input focus + /// \brief Check whether the window has the input focus /// /// \return True if window has focus, false otherwise /// diff --git a/src/SFML/Window/OSX/WindowImplDelegateProtocol.h b/src/SFML/Window/OSX/WindowImplDelegateProtocol.h index e33f91a1b..6c38f5900 100644 --- a/src/SFML/Window/OSX/WindowImplDelegateProtocol.h +++ b/src/SFML/Window/OSX/WindowImplDelegateProtocol.h @@ -176,7 +176,7 @@ namespace sf { -(BOOL)requestFocus; //////////////////////////////////////////////////////////// -/// \brief Determine whether the window has the input focus +/// \brief Check whether the window has the input focus /// /// \return True if window has focus, false otherwise /// diff --git a/src/SFML/Window/Unix/WindowImplX11.hpp b/src/SFML/Window/Unix/WindowImplX11.hpp index 0605cdf9a..9f354e9f6 100644 --- a/src/SFML/Window/Unix/WindowImplX11.hpp +++ b/src/SFML/Window/Unix/WindowImplX11.hpp @@ -164,7 +164,7 @@ public: virtual bool requestFocus(); //////////////////////////////////////////////////////////// - /// \brief Determine whether the window has the input focus + /// \brief Check whether the window has the input focus /// /// \return True if window has focus, false otherwise /// diff --git a/src/SFML/Window/Win32/WindowImplWin32.hpp b/src/SFML/Window/Win32/WindowImplWin32.hpp index e95bfa9fb..d06aae77a 100644 --- a/src/SFML/Window/Win32/WindowImplWin32.hpp +++ b/src/SFML/Window/Win32/WindowImplWin32.hpp @@ -163,7 +163,7 @@ public: virtual bool requestFocus(); //////////////////////////////////////////////////////////// - /// \brief Determine whether the window has the input focus + /// \brief Check whether the window has the input focus /// /// \return True if window has focus, false otherwise /// diff --git a/src/SFML/Window/WindowImpl.hpp b/src/SFML/Window/WindowImpl.hpp index 50ef17237..1b5251e88 100644 --- a/src/SFML/Window/WindowImpl.hpp +++ b/src/SFML/Window/WindowImpl.hpp @@ -204,7 +204,7 @@ public: virtual bool requestFocus() = 0; //////////////////////////////////////////////////////////// - /// \brief Determine whether the window has the input focus + /// \brief Check whether the window has the input focus /// /// \return True if window has focus, false otherwise ///