Slightly adapted window focus documentation

This commit is contained in:
Jan Haller 2014-05-03 14:25:00 +02:00
parent 85291debb4
commit 6a24eb5eec
6 changed files with 10 additions and 11 deletions

View File

@ -417,28 +417,27 @@ public:
/// foreground window /// foreground window
/// ///
/// At any given time, only one window may have the input focus /// At any given time, only one window may have the input focus
/// to receive input events such as keystrokes or mouse /// to receive input events such as keystrokes or mouse events.
/// events.
/// If a window requests focus, it only hints to the operating /// If a window requests focus, it only hints to the operating
/// system, that it would like to be focused. The operating system /// system, that it would like to be focused. The operating system
/// is free to deny the request. For example under Windows OS /// is free to deny the request.
/// windows are not allowed to steal focus. But the user
/// will be notified through a flashing taskbar button.
/// This is not to be confused with setActive(). /// This is not to be confused with setActive().
/// ///
/// \return True if operation was successful, false otherwise /// \return True if operation was successful, false otherwise
/// \see hasFocus
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool requestFocus(); 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 /// At any given time, only one window may have the input focus
/// to receive input events such as keystrokes or most mouse /// to receive input events such as keystrokes or most mouse
/// events. /// events.
/// ///
/// \return True if window has focus, false otherwise /// \return True if window has focus, false otherwise
/// \see requestFocus
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
bool hasFocus() const; bool hasFocus() const;

View File

@ -330,7 +330,7 @@ public:
virtual bool requestFocus(); 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 /// \return True if window has focus, false otherwise
/// ///

View File

@ -176,7 +176,7 @@ namespace sf {
-(BOOL)requestFocus; -(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 /// \return True if window has focus, false otherwise
/// ///

View File

@ -164,7 +164,7 @@ public:
virtual bool requestFocus(); 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 /// \return True if window has focus, false otherwise
/// ///

View File

@ -163,7 +163,7 @@ public:
virtual bool requestFocus(); 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 /// \return True if window has focus, false otherwise
/// ///

View File

@ -204,7 +204,7 @@ public:
virtual bool requestFocus() = 0; 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 /// \return True if window has focus, false otherwise
/// ///