Merge pull request #3079 from damusss/Window-get_focus

Add `Window.focused`

buildconfig/stubs/pygame/window.pyi

@@ -45,6 +45,8 @@ class Window:
     @property
     def keyboard_grabbed(self) -> bool: ...
     @property
+    def focused(self) -> bool: ...
+    @property
     def id(self) -> int: ...
     @property
     def mouse_rect(self) -> Optional[Rect]: ...

docs/reST/ref/window.rst

@@ -128,6 +128,18 @@
 
       .. versionadded:: 2.4.0
 
+   .. attribute:: focused
+
+      | :sl:`Get if the window is focused (**read-only**)`
+      | :sg:`focused -> bool`
+
+      Get if the window is currently focused. The same result can be achieved using
+      the ``WINDOWFOCUSGAINED`` and ``WINDOWFOCUSLOST`` events.
+
+      Use :meth:`focus` to focus and raise the window.
+
+      .. versionadded:: 2.5.2
+
    .. attribute:: title
 
       | :sl:`Get or set the window title`

src_c/doc/window_doc.h

@@ -4,6 +4,7 @@
 #define DOC_WINDOW_GRABKEYBOARD "grab_keyboard -> bool\nGet or set the window's keyboard grab mode"
 #define DOC_WINDOW_MOUSEGRABBED "mouse_grabbed -> bool\nGet if the mouse cursor is confined to the window (**read-only**)"
 #define DOC_WINDOW_KEYBOARDGRABBED "keyboard_grabbed -> bool\nGet if the keyboard shortcuts are captured by the window (**read-only**)"
+#define DOC_WINDOW_FOCUSED "focused -> bool\nGet if the window is focused (**read-only**)"
 #define DOC_WINDOW_TITLE "title -> str\nGet or set the window title"
 #define DOC_WINDOW_RESIZABLE "resizable -> bool\nGet or set whether the window is resizable"
 #define DOC_WINDOW_BORDERLESS "borderless -> bool\nGet or set whether the window is borderless"

src_c/window.c

@@ -303,6 +303,13 @@ window_focus(pgWindowObject *self, PyObject *args, PyObject *kwargs)
     Py_RETURN_NONE;
 }
 
+static PyObject *
+window_get_focused(pgWindowObject *self, void *v)
+{
+    uint32_t flags = SDL_GetWindowFlags(self->_win);
+    return PyBool_FromLong((flags & SDL_WINDOW_INPUT_FOCUS) != 0);
+}
+
 static PyObject *
 window_hide(pgWindowObject *self, PyObject *_null)
 {
@@ -1169,6 +1176,7 @@ static PyGetSetDef _window_getset[] = {
      DOC_WINDOW_MOUSEGRABBED, NULL},
     {"keyboard_grabbed", (getter)window_get_keyboard_grabbed, NULL,
      DOC_WINDOW_KEYBOARDGRABBED, NULL},
+    {"focused", (getter)window_get_focused, NULL, DOC_WINDOW_FOCUSED, NULL},
     {"title", (getter)window_get_title, (setter)window_set_title,
      DOC_WINDOW_TITLE, NULL},
     {"resizable", (getter)window_get_resizable, (setter)window_set_resizable,

test/window_test.py

@@ -449,6 +449,10 @@ def test_window_flash(self):
             except pygame.error:
                 pass
 
+    def test_window_focused(self):
+        window = pygame.Window()
+        self.assertIsInstance(window.focused, bool)
+
     def tearDown(self):
         self.win.destroy()