godot-docs/classes/class_window.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Window.xml.

.. _class_Window:

Window
======

**Inherits:** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`AcceptDialog<class_AcceptDialog>`, :ref:`Popup<class_Popup>`

Base class for all windows.

.. rst-class:: classref-introduction-group

Description
-----------

A node that creates a window. The window can either be a native system window or embedded inside another **Window** (see :ref:`Viewport.gui_embed_subwindows<class_Viewport_property_gui_embed_subwindows>`).

At runtime, **Window**\ s will not close automatically when requested. You need to handle it manually using :ref:`close_requested<class_Window_signal_close_requested>` (this applies both to clicking close button and clicking outside popup).

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`always_on_top<class_Window_property_always_on_top>`                         | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`auto_translate<class_Window_property_auto_translate>`                       | ``true``                 |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`borderless<class_Window_property_borderless>`                               | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>`       | :ref:`content_scale_aspect<class_Window_property_content_scale_aspect>`           | ``0``                    |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                                       | :ref:`content_scale_factor<class_Window_property_content_scale_factor>`           | ``1.0``                  |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`ContentScaleMode<enum_Window_ContentScaleMode>`           | :ref:`content_scale_mode<class_Window_property_content_scale_mode>`               | ``0``                    |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                 | :ref:`content_scale_size<class_Window_property_content_scale_size>`               | ``Vector2i(0, 0)``       |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`int<class_int>`                                           | :ref:`current_screen<class_Window_property_current_screen>`                       |                          |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`exclusive<class_Window_property_exclusive>`                                 | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`extend_to_title<class_Window_property_extend_to_title>`                     | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` | :ref:`initial_position<class_Window_property_initial_position>`                   | ``0``                    |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                 | :ref:`max_size<class_Window_property_max_size>`                                   | ``Vector2i(0, 0)``       |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                 | :ref:`min_size<class_Window_property_min_size>`                                   | ``Vector2i(0, 0)``       |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Mode<enum_Window_Mode>`                                   | :ref:`mode<class_Window_property_mode>`                                           | ``0``                    |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`mouse_passthrough<class_Window_property_mouse_passthrough>`                 | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`PackedVector2Array<class_PackedVector2Array>`             | :ref:`mouse_passthrough_polygon<class_Window_property_mouse_passthrough_polygon>` | ``PackedVector2Array()`` |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`popup_window<class_Window_property_popup_window>`                           | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                 | :ref:`position<class_Window_property_position>`                                   | ``Vector2i(0, 0)``       |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                 | :ref:`size<class_Window_property_size>`                                           | ``Vector2i(100, 100)``   |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`Theme<class_Theme>`                                       | :ref:`theme<class_Window_property_theme>`                                         |                          |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`StringName<class_StringName>`                             | :ref:`theme_type_variation<class_Window_property_theme_type_variation>`           | ``&""``                  |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`String<class_String>`                                     | :ref:`title<class_Window_property_title>`                                         | ``""``                   |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`transient<class_Window_property_transient>`                                 | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`transparent<class_Window_property_transparent>`                             | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`unfocusable<class_Window_property_unfocusable>`                             | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`unresizable<class_Window_property_unresizable>`                             | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`visible<class_Window_property_visible>`                                     | ``true``                 |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`wrap_controls<class_Window_property_wrap_controls>`                         | ``false``                |
   +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_color_override<class_Window_method_add_theme_color_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)**                         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_constant_override<class_Window_method_add_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)**                    |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_font_override<class_Window_method_add_theme_font_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)**                              |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_font_size_override<class_Window_method_add_theme_font_size_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` font_size **)**                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_icon_override<class_Window_method_add_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)**                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`add_theme_stylebox_override<class_Window_method_add_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**          |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`begin_bulk_theme_override<class_Window_method_begin_bulk_theme_override>` **(** **)**                                                                                                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`can_draw<class_Window_method_can_draw>` **(** **)** |const|                                                                                                                           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`child_controls_changed<class_Window_method_child_controls_changed>` **(** **)**                                                                                                       |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`end_bulk_theme_override<class_Window_method_end_bulk_theme_override>` **(** **)**                                                                                                     |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                       | :ref:`get_contents_minimum_size<class_Window_method_get_contents_minimum_size>` **(** **)** |const|                                                                                         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`get_flag<class_Window_method_get_flag>` **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|                                                                                      |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`LayoutDirection<enum_Window_LayoutDirection>` | :ref:`get_layout_direction<class_Window_method_get_layout_direction>` **(** **)** |const|                                                                                                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                     | :ref:`get_position_with_decorations<class_Window_method_get_position_with_decorations>` **(** **)** |const|                                                                                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                     | :ref:`get_size_with_decorations<class_Window_method_get_size_with_decorations>` **(** **)** |const|                                                                                         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                           | :ref:`get_theme_color<class_Window_method_get_theme_color>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_theme_constant<class_Window_method_get_theme_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                           | :ref:`get_theme_default_base_scale<class_Window_method_get_theme_default_base_scale>` **(** **)** |const|                                                                                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Font<class_Font>`                             | :ref:`get_theme_default_font<class_Window_method_get_theme_default_font>` **(** **)** |const|                                                                                               |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_theme_default_font_size<class_Window_method_get_theme_default_font_size>` **(** **)** |const|                                                                                     |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Font<class_Font>`                             | :ref:`get_theme_font<class_Window_method_get_theme_font>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                               | :ref:`get_theme_font_size<class_Window_method_get_theme_font_size>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>`                   | :ref:`get_theme_icon<class_Window_method_get_theme_icon>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StyleBox<class_StyleBox>`                     | :ref:`get_theme_stylebox<class_Window_method_get_theme_stylebox>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`grab_focus<class_Window_method_grab_focus>` **(** **)**                                                                                                                               |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_focus<class_Window_method_has_focus>` **(** **)** |const|                                                                                                                         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_color<class_Window_method_has_theme_color>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_color_override<class_Window_method_has_theme_color_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                                  |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_constant<class_Window_method_has_theme_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_constant_override<class_Window_method_has_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                            |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_font<class_Window_method_has_theme_font>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_font_override<class_Window_method_has_theme_font_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                                    |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_font_size<class_Window_method_has_theme_font_size>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|         |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_font_size_override<class_Window_method_has_theme_font_size_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                          |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_icon<class_Window_method_has_theme_icon>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|                   |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_icon_override<class_Window_method_has_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                                    |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_stylebox<class_Window_method_has_theme_stylebox>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`has_theme_stylebox_override<class_Window_method_has_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name **)** |const|                                            |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`hide<class_Window_method_hide>` **(** **)**                                                                                                                                           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`is_embedded<class_Window_method_is_embedded>` **(** **)** |const|                                                                                                                     |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`is_layout_rtl<class_Window_method_is_layout_rtl>` **(** **)** |const|                                                                                                                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`is_maximize_allowed<class_Window_method_is_maximize_allowed>` **(** **)** |const|                                                                                                     |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                             | :ref:`is_using_font_oversampling<class_Window_method_is_using_font_oversampling>` **(** **)** |const|                                                                                       |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`move_to_foreground<class_Window_method_move_to_foreground>` **(** **)**                                                                                                               |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`popup<class_Window_method_popup>` **(** :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**                                                                                     |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`popup_centered<class_Window_method_popup_centered>` **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**                                                                |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`popup_centered_clamped<class_Window_method_popup_centered_clamped>` **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)** |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`popup_centered_ratio<class_Window_method_popup_centered_ratio>` **(** :ref:`float<class_float>` ratio=0.8 **)**                                                                       |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`popup_on_parent<class_Window_method_popup_on_parent>` **(** :ref:`Rect2i<class_Rect2i>` parent_rect **)**                                                                             |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_color_override<class_Window_method_remove_theme_color_override>` **(** :ref:`StringName<class_StringName>` name **)**                                                    |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_constant_override<class_Window_method_remove_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name **)**                                              |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_font_override<class_Window_method_remove_theme_font_override>` **(** :ref:`StringName<class_StringName>` name **)**                                                      |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_font_size_override<class_Window_method_remove_theme_font_size_override>` **(** :ref:`StringName<class_StringName>` name **)**                                            |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_icon_override<class_Window_method_remove_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name **)**                                                      |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`remove_theme_stylebox_override<class_Window_method_remove_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name **)**                                              |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`request_attention<class_Window_method_request_attention>` **(** **)**                                                                                                                 |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`reset_size<class_Window_method_reset_size>` **(** **)**                                                                                                                               |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_flag<class_Window_method_set_flag>` **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**                                                             |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_ime_active<class_Window_method_set_ime_active>` **(** :ref:`bool<class_bool>` active **)**                                                                                        |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_ime_position<class_Window_method_set_ime_position>` **(** :ref:`Vector2i<class_Vector2i>` position **)**                                                                          |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_layout_direction<class_Window_method_set_layout_direction>` **(** :ref:`LayoutDirection<enum_Window_LayoutDirection>` direction **)**                                             |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`set_use_font_oversampling<class_Window_method_set_use_font_oversampling>` **(** :ref:`bool<class_bool>` enable **)**                                                                  |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                | :ref:`show<class_Window_method_show>` **(** **)**                                                                                                                                           |
   +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Theme Properties
----------------

.. table::
   :widths: auto

   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`title_color<class_Window_theme_color_title_color>`                       | ``Color(0.875, 0.875, 0.875, 1)`` |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`title_outline_modulate<class_Window_theme_color_title_outline_modulate>` | ``Color(1, 1, 1, 1)``             |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`close_h_offset<class_Window_theme_constant_close_h_offset>`              | ``18``                            |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`close_v_offset<class_Window_theme_constant_close_v_offset>`              | ``24``                            |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`resize_margin<class_Window_theme_constant_resize_margin>`                | ``4``                             |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`title_height<class_Window_theme_constant_title_height>`                  | ``36``                            |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`title_outline_size<class_Window_theme_constant_title_outline_size>`      | ``0``                             |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Font<class_Font>`           | :ref:`title_font<class_Window_theme_font_title_font>`                          |                                   |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`title_font_size<class_Window_theme_font_size_title_font_size>`           |                                   |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`close<class_Window_theme_icon_close>`                                    |                                   |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`close_pressed<class_Window_theme_icon_close_pressed>`                    |                                   |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`embedded_border<class_Window_theme_style_embedded_border>`               |                                   |
   +-----------------------------------+--------------------------------------------------------------------------------+-----------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_Window_signal_about_to_popup:

.. rst-class:: classref-signal

**about_to_popup** **(** **)**

Emitted right after :ref:`popup<class_Window_method_popup>` call, before the **Window** appears or does anything.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_close_requested:

.. rst-class:: classref-signal

**close_requested** **(** **)**

Emitted when the **Window**'s close button is pressed or when :ref:`popup_window<class_Window_property_popup_window>` is enabled and user clicks outside the window.

This signal can be used to handle window closing, e.g. by connecting it to :ref:`hide<class_Window_method_hide>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_dpi_changed:

.. rst-class:: classref-signal

**dpi_changed** **(** **)**

Emitted when the **Window**'s DPI changes as a result of OS-level changes (e.g. moving the window from a Retina display to a lower resolution one).

\ **Note:** Only implemented on macOS.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_files_dropped:

.. rst-class:: classref-signal

**files_dropped** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**

Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths.

Note that this method only works with non-embedded windows, i.e. the main window and **Window**-derived nodes when :ref:`Viewport.gui_embed_subwindows<class_Viewport_property_gui_embed_subwindows>` is disabled in the main viewport.

Example usage:

::

    func _ready():
        get_viewport().files_dropped.connect(on_files_dropped)
    
    func on_files_dropped(files):
        print(files)

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_focus_entered:

.. rst-class:: classref-signal

**focus_entered** **(** **)**

Emitted when the **Window** gains focus.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_focus_exited:

.. rst-class:: classref-signal

**focus_exited** **(** **)**

Emitted when the **Window** loses its focus.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_go_back_requested:

.. rst-class:: classref-signal

**go_back_requested** **(** **)**

Emitted when a go back request is sent (e.g. pressing the "Back" button on Android), right after :ref:`Node.NOTIFICATION_WM_GO_BACK_REQUEST<class_Node_constant_NOTIFICATION_WM_GO_BACK_REQUEST>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_mouse_entered:

.. rst-class:: classref-signal

**mouse_entered** **(** **)**

Emitted when the mouse cursor enters the **Window**'s area, regardless if it's currently focused or not.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_mouse_exited:

.. rst-class:: classref-signal

**mouse_exited** **(** **)**

Emitted when the mouse cursor exits the **Window**'s area (including when it's hovered over another window on top of this one).

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_theme_changed:

.. rst-class:: classref-signal

**theme_changed** **(** **)**

Emitted when the :ref:`NOTIFICATION_THEME_CHANGED<class_Window_constant_NOTIFICATION_THEME_CHANGED>` notification is sent.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_titlebar_changed:

.. rst-class:: classref-signal

**titlebar_changed** **(** **)**

Emitted when window title bar decorations are changed, e.g. macOS window enter/exit full screen mode, or extend-to-title flag is changed.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_visibility_changed:

.. rst-class:: classref-signal

**visibility_changed** **(** **)**

Emitted when **Window** is made visible or disappears.

.. rst-class:: classref-item-separator

----

.. _class_Window_signal_window_input:

.. rst-class:: classref-signal

**window_input** **(** :ref:`InputEvent<class_InputEvent>` event **)**

Emitted when the **Window** is currently focused and receives any input, passing the received event as an argument. The event's position, if present, is in the embedder's coordinate system.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_Window_Mode:

.. rst-class:: classref-enumeration

enum **Mode**:

.. _class_Window_constant_MODE_WINDOWED:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_Window_Mode>` **MODE_WINDOWED** = ``0``

Windowed mode, i.e. **Window** doesn't occupy the whole screen (unless set to the size of the screen).

.. _class_Window_constant_MODE_MINIMIZED:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_Window_Mode>` **MODE_MINIMIZED** = ``1``

Minimized window mode, i.e. **Window** is not visible and available on window manager's window list. Normally happens when the minimize button is pressed.

.. _class_Window_constant_MODE_MAXIMIZED:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_Window_Mode>` **MODE_MAXIMIZED** = ``2``

Maximized window mode, i.e. **Window** will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed.

.. _class_Window_constant_MODE_FULLSCREEN:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_Window_Mode>` **MODE_FULLSCREEN** = ``3``

Full screen window mode. Note that this is not *exclusive* full screen. On Windows and Linux, a borderless window is used to emulate full screen. On macOS, a new desktop is used to display the running project.

Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.

.. _class_Window_constant_MODE_EXCLUSIVE_FULLSCREEN:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_Window_Mode>` **MODE_EXCLUSIVE_FULLSCREEN** = ``4``

Exclusive full screen window mode. This mode is implemented on Windows only. On other platforms, it is equivalent to :ref:`MODE_FULLSCREEN<class_Window_constant_MODE_FULLSCREEN>`.

Only one window in exclusive full screen mode can be visible on a given screen at a time. If multiple windows are in exclusive full screen mode for the same screen, the last one being set to this mode takes precedence.

Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.

.. rst-class:: classref-item-separator

----

.. _enum_Window_Flags:

.. rst-class:: classref-enumeration

enum **Flags**:

.. _class_Window_constant_FLAG_RESIZE_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_RESIZE_DISABLED** = ``0``

The window can't be resizing by dragging its resize grip. It's still possible to resize the window using :ref:`size<class_Window_property_size>`. This flag is ignored for full screen windows. Set with :ref:`unresizable<class_Window_property_unresizable>`.

.. _class_Window_constant_FLAG_BORDERLESS:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_BORDERLESS** = ``1``

The window do not have native title bar and other decorations. This flag is ignored for full-screen windows. Set with :ref:`borderless<class_Window_property_borderless>`.

.. _class_Window_constant_FLAG_ALWAYS_ON_TOP:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_ALWAYS_ON_TOP** = ``2``

The window is floating on top of all other windows. This flag is ignored for full-screen windows. Set with :ref:`always_on_top<class_Window_property_always_on_top>`.

.. _class_Window_constant_FLAG_TRANSPARENT:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_TRANSPARENT** = ``3``

The window background can be transparent.

\ **Note:** This flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``. Set with :ref:`transparent<class_Window_property_transparent>`.

.. _class_Window_constant_FLAG_NO_FOCUS:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_NO_FOCUS** = ``4``

The window can't be focused. No-focus window will ignore all input, except mouse clicks. Set with :ref:`unfocusable<class_Window_property_unfocusable>`.

.. _class_Window_constant_FLAG_POPUP:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_POPUP** = ``5``

Window is part of menu or :ref:`OptionButton<class_OptionButton>` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have ``transient parent`` set (see :ref:`transient<class_Window_property_transient>`).

.. _class_Window_constant_FLAG_EXTEND_TO_TITLE:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_EXTEND_TO_TITLE** = ``6``

Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. Set with :ref:`extend_to_title<class_Window_property_extend_to_title>`.

\ **Note:** This flag is implemented on macOS.

.. _class_Window_constant_FLAG_MOUSE_PASSTHROUGH:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_MOUSE_PASSTHROUGH** = ``7``

All mouse events are passed to the underlying window of the same application.

.. _class_Window_constant_FLAG_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_Window_Flags>` **FLAG_MAX** = ``8``

Max value of the :ref:`Flags<enum_Window_Flags>`.

.. rst-class:: classref-item-separator

----

.. _enum_Window_ContentScaleMode:

.. rst-class:: classref-enumeration

enum **ContentScaleMode**:

.. _class_Window_constant_CONTENT_SCALE_MODE_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_DISABLED** = ``0``

The content will not be scaled to match the **Window**'s size.

.. _class_Window_constant_CONTENT_SCALE_MODE_CANVAS_ITEMS:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_CANVAS_ITEMS** = ``1``

The content will be rendered at the target size. This is more performance-expensive than :ref:`CONTENT_SCALE_MODE_VIEWPORT<class_Window_constant_CONTENT_SCALE_MODE_VIEWPORT>`, but provides better results.

.. _class_Window_constant_CONTENT_SCALE_MODE_VIEWPORT:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_VIEWPORT** = ``2``

The content will be rendered at the base size and then scaled to the target size. More performant than :ref:`CONTENT_SCALE_MODE_CANVAS_ITEMS<class_Window_constant_CONTENT_SCALE_MODE_CANVAS_ITEMS>`, but results in pixelated image.

.. rst-class:: classref-item-separator

----

.. _enum_Window_ContentScaleAspect:

.. rst-class:: classref-enumeration

enum **ContentScaleAspect**:

.. _class_Window_constant_CONTENT_SCALE_ASPECT_IGNORE:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_IGNORE** = ``0``

The aspect will be ignored. Scaling will simply stretch the content to fit the target size.

.. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP** = ``1``

The content's aspect will be preserved. If the target size has different aspect from the base one, the image will be centered and black bars will appear on left and right sides.

.. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP_WIDTH:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP_WIDTH** = ``2``

The content can be expanded vertically. Scaling horizontally will result in keeping the width ratio and then black bars on left and right sides.

.. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP_HEIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP_HEIGHT** = ``3``

The content can be expanded horizontally. Scaling vertically will result in keeping the height ratio and then black bars on top and bottom sides.

.. _class_Window_constant_CONTENT_SCALE_ASPECT_EXPAND:

.. rst-class:: classref-enumeration-constant

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_EXPAND** = ``4``

The content's aspect will be preserved. If the target size has different aspect from the base one, the content will stay in the to-left corner and add an extra visible area in the stretched space.

.. rst-class:: classref-item-separator

----

.. _enum_Window_LayoutDirection:

.. rst-class:: classref-enumeration

enum **LayoutDirection**:

.. _class_Window_constant_LAYOUT_DIRECTION_INHERITED:

.. rst-class:: classref-enumeration-constant

:ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_INHERITED** = ``0``

Automatic layout direction, determined from the parent window layout direction.

.. _class_Window_constant_LAYOUT_DIRECTION_LOCALE:

.. rst-class:: classref-enumeration-constant

:ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_LOCALE** = ``1``

Automatic layout direction, determined from the current locale.

.. _class_Window_constant_LAYOUT_DIRECTION_LTR:

.. rst-class:: classref-enumeration-constant

:ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_LTR** = ``2``

Left-to-right layout direction.

.. _class_Window_constant_LAYOUT_DIRECTION_RTL:

.. rst-class:: classref-enumeration-constant

:ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_RTL** = ``3``

Right-to-left layout direction.

.. rst-class:: classref-item-separator

----

.. _enum_Window_WindowInitialPosition:

.. rst-class:: classref-enumeration

enum **WindowInitialPosition**:

.. _class_Window_constant_WINDOW_INITIAL_POSITION_ABSOLUTE:

.. rst-class:: classref-enumeration-constant

:ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_ABSOLUTE** = ``0``

Initial window position is determined by :ref:`position<class_Window_property_position>`.

.. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN:

.. rst-class:: classref-enumeration-constant

:ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN** = ``1``

Initial window position is a center of the primary screen.

.. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN:

.. rst-class:: classref-enumeration-constant

:ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN** = ``2``

Initial window position is a center of the main window screen.

.. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN:

.. rst-class:: classref-enumeration-constant

:ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN** = ``3``

Initial window position is a center of :ref:`current_screen<class_Window_property_current_screen>` screen.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Constants
---------

.. _class_Window_constant_NOTIFICATION_VISIBILITY_CHANGED:

.. rst-class:: classref-constant

**NOTIFICATION_VISIBILITY_CHANGED** = ``30``

Emitted when **Window**'s visibility changes, right before :ref:`visibility_changed<class_Window_signal_visibility_changed>`.

.. _class_Window_constant_NOTIFICATION_THEME_CHANGED:

.. rst-class:: classref-constant

**NOTIFICATION_THEME_CHANGED** = ``32``

Sent when the node needs to refresh its theme items. This happens in one of the following cases:

- The :ref:`theme<class_Window_property_theme>` property is changed on this node or any of its ancestors.

- The :ref:`theme_type_variation<class_Window_property_theme_type_variation>` property is changed on this node.

- The node enters the scene tree.

\ **Note:** As an optimization, this notification won't be sent from changes that occur while this node is outside of the scene tree. Instead, all of the theme item updates can be applied at once when the node enters the scene tree.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_Window_property_always_on_top:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **always_on_top** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the window will be on top of all other windows. Does not work if :ref:`transient<class_Window_property_transient>` is enabled.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_auto_translate:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **auto_translate** = ``true``

.. rst-class:: classref-property-setget

- void **set_auto_translate** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_auto_translating** **(** **)**

Toggles if any text should automatically change to its translated version depending on the current locale.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_borderless:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **borderless** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the window will have no borders.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_content_scale_aspect:

.. rst-class:: classref-property

:ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **content_scale_aspect** = ``0``

.. rst-class:: classref-property-setget

- void **set_content_scale_aspect** **(** :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` value **)**
- :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **get_content_scale_aspect** **(** **)**

Specifies how the content's aspect behaves when the **Window** is resized. The base aspect is determined by :ref:`content_scale_size<class_Window_property_content_scale_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_content_scale_factor:

.. rst-class:: classref-property

:ref:`float<class_float>` **content_scale_factor** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_content_scale_factor** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_content_scale_factor** **(** **)**

Specifies the base scale of **Window**'s content when its :ref:`size<class_Window_property_size>` is equal to :ref:`content_scale_size<class_Window_property_content_scale_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_content_scale_mode:

.. rst-class:: classref-property

:ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **content_scale_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_content_scale_mode** **(** :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` value **)**
- :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **get_content_scale_mode** **(** **)**

Specifies how the content is scaled when the **Window** is resized.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_content_scale_size:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **content_scale_size** = ``Vector2i(0, 0)``

.. rst-class:: classref-property-setget

- void **set_content_scale_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_content_scale_size** **(** **)**

Base size of the content (i.e. nodes that are drawn inside the window). If non-zero, **Window**'s content will be scaled when the window is resized to a different size.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_current_screen:

.. rst-class:: classref-property

:ref:`int<class_int>` **current_screen**

.. rst-class:: classref-property-setget

- void **set_current_screen** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_current_screen** **(** **)**

The screen the window is currently on.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_exclusive:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **exclusive** = ``false``

.. rst-class:: classref-property-setget

- void **set_exclusive** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_exclusive** **(** **)**

If ``true``, the **Window** will be in exclusive mode. Exclusive windows are always on top of their parent and will block all input going to the parent **Window**.

Needs :ref:`transient<class_Window_property_transient>` enabled to work.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_extend_to_title:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **extend_to_title** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the **Window** contents is expanded to the full size of the window, window title bar is transparent.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_initial_position:

.. rst-class:: classref-property

:ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **initial_position** = ``0``

.. rst-class:: classref-property-setget

- void **set_initial_position** **(** :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` value **)**
- :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **get_initial_position** **(** **)**

.. container:: contribute

	There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_Window_property_max_size:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **max_size** = ``Vector2i(0, 0)``

.. rst-class:: classref-property-setget

- void **set_max_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_max_size** **(** **)**

If non-zero, the **Window** can't be resized to be bigger than this size.

\ **Note:** This property will be ignored if the value is lower than :ref:`min_size<class_Window_property_min_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_min_size:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **min_size** = ``Vector2i(0, 0)``

.. rst-class:: classref-property-setget

- void **set_min_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_min_size** **(** **)**

If non-zero, the **Window** can't be resized to be smaller than this size.

\ **Note:** This property will be ignored in favor of :ref:`get_contents_minimum_size<class_Window_method_get_contents_minimum_size>` if :ref:`wrap_controls<class_Window_property_wrap_controls>` is enabled and if its size is bigger.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_mode:

.. rst-class:: classref-property

:ref:`Mode<enum_Window_Mode>` **mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_mode** **(** :ref:`Mode<enum_Window_Mode>` value **)**
- :ref:`Mode<enum_Window_Mode>` **get_mode** **(** **)**

Set's the window's current mode.

\ **Note:** Fullscreen mode is not exclusive full screen on Windows and Linux.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_mouse_passthrough:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **mouse_passthrough** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, all mouse event as passed to the underlying window of the same application. See also :ref:`mouse_passthrough_polygon<class_Window_property_mouse_passthrough_polygon>`.

\ **Note:** This property is implemented on Linux (X11), macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_mouse_passthrough_polygon:

.. rst-class:: classref-property

:ref:`PackedVector2Array<class_PackedVector2Array>` **mouse_passthrough_polygon** = ``PackedVector2Array()``

.. rst-class:: classref-property-setget

- void **set_mouse_passthrough_polygon** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` value **)**
- :ref:`PackedVector2Array<class_PackedVector2Array>` **get_mouse_passthrough_polygon** **(** **)**

Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.

Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).


.. tabs::

 .. code-tab:: gdscript

    # Set region, using Path2D node.
    $Window.mouse_passthrough_polygon = $Path2D.curve.get_baked_points()
    
    # Set region, using Polygon2D node.
    $Window.mouse_passthrough_polygon = $Polygon2D.polygon
    
    # Reset region to default.
    $Window.mouse_passthrough_polygon = []

 .. code-tab:: csharp

    // Set region, using Path2D node.
    GetNode<Window>("Window").MousePassthrough = GetNode<Path2D>("Path2D").Curve.GetBakedPoints();
    
    // Set region, using Polygon2D node.
    GetNode<Window>("Window").MousePassthrough = GetNode<Polygon2D>("Polygon2D").Polygon;
    
    // Reset region to default.
    GetNode<Window>("Window").MousePassthrough = new Vector2[] {};



\ **Note:** This property is ignored if :ref:`mouse_passthrough<class_Window_property_mouse_passthrough>` is set to ``true``.

\ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.

\ **Note:** This property is implemented on Linux (X11), macOS and Windows.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_popup_window:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **popup_window** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the **Window** will be considered a popup. Popups are sub-windows that don't show as separate windows in system's window manager's window list and will send close request when anything is clicked outside of them (unless :ref:`exclusive<class_Window_property_exclusive>` is enabled).

.. rst-class:: classref-item-separator

----

.. _class_Window_property_position:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **position** = ``Vector2i(0, 0)``

.. rst-class:: classref-property-setget

- void **set_position** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_position** **(** **)**

The window's position in pixels.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_size:

.. rst-class:: classref-property

:ref:`Vector2i<class_Vector2i>` **size** = ``Vector2i(100, 100)``

.. rst-class:: classref-property-setget

- void **set_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
- :ref:`Vector2i<class_Vector2i>` **get_size** **(** **)**

The window's size in pixels.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_theme:

.. rst-class:: classref-property

:ref:`Theme<class_Theme>` **theme**

.. rst-class:: classref-property-setget

- void **set_theme** **(** :ref:`Theme<class_Theme>` value **)**
- :ref:`Theme<class_Theme>` **get_theme** **(** **)**

The :ref:`Theme<class_Theme>` resource this node and all its :ref:`Control<class_Control>` and **Window** children use. If a child node has its own :ref:`Theme<class_Theme>` resource set, theme items are merged with child's definitions having higher priority.

\ **Note:** **Window** styles will have no effect unless the window is embedded.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_theme_type_variation:

.. rst-class:: classref-property

:ref:`StringName<class_StringName>` **theme_type_variation** = ``&""``

.. rst-class:: classref-property-setget

- void **set_theme_type_variation** **(** :ref:`StringName<class_StringName>` value **)**
- :ref:`StringName<class_StringName>` **get_theme_type_variation** **(** **)**

The name of a theme type variation used by this **Window** to look up its own theme items. See :ref:`Control.theme_type_variation<class_Control_property_theme_type_variation>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_title:

.. rst-class:: classref-property

:ref:`String<class_String>` **title** = ``""``

.. rst-class:: classref-property-setget

- void **set_title** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_title** **(** **)**

The window's title. If the **Window** is non-embedded, title styles set in :ref:`Theme<class_Theme>` will have no effect.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_transient:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **transient** = ``false``

.. rst-class:: classref-property-setget

- void **set_transient** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_transient** **(** **)**

If ``true``, the **Window** is transient, i.e. it's considered a child of another **Window**. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.

Note that behavior might be different depending on the platform.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_transparent:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **transparent** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the **Window**'s background can be transparent. This is best used with embedded windows.

\ **Note:** For native windows, this flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``.

\ **Note:** Transparency support is implemented on Linux, macOS and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_unfocusable:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **unfocusable** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the **Window** can't be focused nor interacted with. It can still be visible.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_unresizable:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **unresizable** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

If ``true``, the window can't be resized. Minimize and maximize buttons are disabled.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_visible:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **visible** = ``true``

.. rst-class:: classref-property-setget

- void **set_visible** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_visible** **(** **)**

If ``true``, the window is visible.

.. rst-class:: classref-item-separator

----

.. _class_Window_property_wrap_controls:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **wrap_controls** = ``false``

.. rst-class:: classref-property-setget

- void **set_wrap_controls** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_wrapping_controls** **(** **)**

If ``true``, the window's size will automatically update when a child node is added or removed, ignoring :ref:`min_size<class_Window_property_min_size>` if the new size is bigger.

If ``false``, you need to call :ref:`child_controls_changed<class_Window_method_child_controls_changed>` manually.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_Window_method_add_theme_color_override:

.. rst-class:: classref-method

void **add_theme_color_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)**

Creates a local override for a theme :ref:`Color<class_Color>` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_color_override<class_Window_method_remove_theme_color_override>`.

See also :ref:`get_theme_color<class_Window_method_get_theme_color>` and :ref:`Control.add_theme_color_override<class_Control_method_add_theme_color_override>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_add_theme_constant_override:

.. rst-class:: classref-method

void **add_theme_constant_override** **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)**

Creates a local override for a theme constant with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_constant_override<class_Window_method_remove_theme_constant_override>`.

See also :ref:`get_theme_constant<class_Window_method_get_theme_constant>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_add_theme_font_override:

.. rst-class:: classref-method

void **add_theme_font_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)**

Creates a local override for a theme :ref:`Font<class_Font>` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_override<class_Window_method_remove_theme_font_override>`.

See also :ref:`get_theme_font<class_Window_method_get_theme_font>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_add_theme_font_size_override:

.. rst-class:: classref-method

void **add_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` font_size **)**

Creates a local override for a theme font size with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_font_size_override<class_Window_method_remove_theme_font_size_override>`.

See also :ref:`get_theme_font_size<class_Window_method_get_theme_font_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_add_theme_icon_override:

.. rst-class:: classref-method

void **add_theme_icon_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)**

Creates a local override for a theme icon with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_icon_override<class_Window_method_remove_theme_icon_override>`.

See also :ref:`get_theme_icon<class_Window_method_get_theme_icon>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_add_theme_stylebox_override:

.. rst-class:: classref-method

void **add_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**

Creates a local override for a theme :ref:`StyleBox<class_StyleBox>` with the specified ``name``. Local overrides always take precedence when fetching theme items for the control. An override can be removed with :ref:`remove_theme_stylebox_override<class_Window_method_remove_theme_stylebox_override>`.

See also :ref:`get_theme_stylebox<class_Window_method_get_theme_stylebox>` and :ref:`Control.add_theme_stylebox_override<class_Control_method_add_theme_stylebox_override>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_begin_bulk_theme_override:

.. rst-class:: classref-method

void **begin_bulk_theme_override** **(** **)**

Prevents ``*_theme_*_override`` methods from emitting :ref:`NOTIFICATION_THEME_CHANGED<class_Window_constant_NOTIFICATION_THEME_CHANGED>` until :ref:`end_bulk_theme_override<class_Window_method_end_bulk_theme_override>` is called.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_can_draw:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **can_draw** **(** **)** |const|

Returns whether the window is being drawn to the screen.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_child_controls_changed:

.. rst-class:: classref-method

void **child_controls_changed** **(** **)**

Requests an update of the **Window** size to fit underlying :ref:`Control<class_Control>` nodes.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_end_bulk_theme_override:

.. rst-class:: classref-method

void **end_bulk_theme_override** **(** **)**

Ends a bulk theme override update. See :ref:`begin_bulk_theme_override<class_Window_method_begin_bulk_theme_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_contents_minimum_size:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_contents_minimum_size** **(** **)** |const|

Returns the combined minimum size from the child :ref:`Control<class_Control>` nodes of the window. Use :ref:`child_controls_changed<class_Window_method_child_controls_changed>` to update it when children nodes have changed.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_flag:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|

Returns ``true`` if the ``flag`` is set.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_layout_direction:

.. rst-class:: classref-method

:ref:`LayoutDirection<enum_Window_LayoutDirection>` **get_layout_direction** **(** **)** |const|

Returns layout direction and text writing direction.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_position_with_decorations:

.. rst-class:: classref-method

:ref:`Vector2i<class_Vector2i>` **get_position_with_decorations** **(** **)** |const|

Returns the window's position including its border.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_size_with_decorations:

.. rst-class:: classref-method

:ref:`Vector2i<class_Vector2i>` **get_size_with_decorations** **(** **)** |const|

Returns the window's size including its border.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_theme_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns a :ref:`Color<class_Color>` from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a color item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_constant:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_theme_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns a constant from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a constant item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_default_base_scale:

.. rst-class:: classref-method

:ref:`float<class_float>` **get_theme_default_base_scale** **(** **)** |const|

Returns the default base scale value from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a valid :ref:`Theme.default_base_scale<class_Theme_property_default_base_scale>` value.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_default_font:

.. rst-class:: classref-method

:ref:`Font<class_Font>` **get_theme_default_font** **(** **)** |const|

Returns the default font from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a valid :ref:`Theme.default_font<class_Theme_property_default_font>` value.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_default_font_size:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_theme_default_font_size** **(** **)** |const|

Returns the default font size value from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a valid :ref:`Theme.default_font_size<class_Theme_property_default_font_size>` value.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_font:

.. rst-class:: classref-method

:ref:`Font<class_Font>` **get_theme_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns a :ref:`Font<class_Font>` from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a font item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_font_size:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_theme_font_size** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns a font size from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a font size item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_icon:

.. rst-class:: classref-method

:ref:`Texture2D<class_Texture2D>` **get_theme_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns an icon from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has an icon item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_get_theme_stylebox:

.. rst-class:: classref-method

:ref:`StyleBox<class_StyleBox>` **get_theme_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns a :ref:`StyleBox<class_StyleBox>` from the first matching :ref:`Theme<class_Theme>` in the tree if that :ref:`Theme<class_Theme>` has a stylebox item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_grab_focus:

.. rst-class:: classref-method

void **grab_focus** **(** **)**

Causes the window to grab focus, allowing it to receive user input.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_focus:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_focus** **(** **)** |const|

Returns ``true`` if the window is focused.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_color:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has a color item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_color_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_color_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme :ref:`Color<class_Color>` with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_color_override<class_Window_method_add_theme_color_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_constant:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has a constant item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_constant_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_constant_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_constant_override<class_Window_method_add_theme_constant_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_font:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has a font item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_font_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_font_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme :ref:`Font<class_Font>` with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_font_override<class_Window_method_add_theme_font_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_font_size:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_font_size** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has a font size item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_font_size_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_font_size_override<class_Window_method_add_theme_font_size_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_icon:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has an icon item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_icon_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_icon_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_icon_override<class_Window_method_add_theme_icon_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_stylebox:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|

Returns ``true`` if there is a matching :ref:`Theme<class_Theme>` in the tree that has a stylebox item with the specified ``name`` and ``theme_type``.

See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_has_theme_stylebox_override:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name **)** |const|

Returns ``true`` if there is a local override for a theme :ref:`StyleBox<class_StyleBox>` with the specified ``name`` in this :ref:`Control<class_Control>` node.

See :ref:`add_theme_stylebox_override<class_Window_method_add_theme_stylebox_override>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_hide:

.. rst-class:: classref-method

void **hide** **(** **)**

Hides the window. This is not the same as minimized state. Hidden window can't be interacted with and needs to be made visible with :ref:`show<class_Window_method_show>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_is_embedded:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_embedded** **(** **)** |const|

Returns ``true`` if the window is currently embedded in another window.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_is_layout_rtl:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_layout_rtl** **(** **)** |const|

Returns ``true`` if layout is right-to-left.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_is_maximize_allowed:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_maximize_allowed** **(** **)** |const|

Returns ``true`` if the window can be maximized (the maximize button is enabled).

.. rst-class:: classref-item-separator

----

.. _class_Window_method_is_using_font_oversampling:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_using_font_oversampling** **(** **)** |const|

Returns ``true`` if font oversampling is enabled. See :ref:`set_use_font_oversampling<class_Window_method_set_use_font_oversampling>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_move_to_foreground:

.. rst-class:: classref-method

void **move_to_foreground** **(** **)**

Moves the **Window** on top of other windows and focuses it.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_popup:

.. rst-class:: classref-method

void **popup** **(** :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**

Shows the **Window** and makes it transient (see :ref:`transient<class_Window_property_transient>`). If ``rect`` is provided, it will be set as the **Window**'s size.

Fails if called on the main window.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_popup_centered:

.. rst-class:: classref-method

void **popup_centered** **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**

Popups the **Window** at the center of the current screen, with optionally given minimum size.

If the **Window** is embedded, it will be centered in the parent :ref:`Viewport<class_Viewport>` instead.

\ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size<class_Window_property_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_popup_centered_clamped:

.. rst-class:: classref-method

void **popup_centered_clamped** **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**

Popups the **Window** centered inside its parent **Window**.

\ ``fallback_ratio`` determines the maximum size of the **Window**, in relation to its parent.

\ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size<class_Window_property_size>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_popup_centered_ratio:

.. rst-class:: classref-method

void **popup_centered_ratio** **(** :ref:`float<class_float>` ratio=0.8 **)**

Popups the **Window** centered inside its parent **Window** and sets its size as a ``ratio`` of parent's size.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_popup_on_parent:

.. rst-class:: classref-method

void **popup_on_parent** **(** :ref:`Rect2i<class_Rect2i>` parent_rect **)**

Popups the **Window** with a position shifted by parent **Window**'s position.

If the **Window** is embedded, has the same effect as :ref:`popup<class_Window_method_popup>`.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_color_override:

.. rst-class:: classref-method

void **remove_theme_color_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme :ref:`Color<class_Color>` with the specified ``name`` previously added by :ref:`add_theme_color_override<class_Window_method_add_theme_color_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_constant_override:

.. rst-class:: classref-method

void **remove_theme_constant_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme constant with the specified ``name`` previously added by :ref:`add_theme_constant_override<class_Window_method_add_theme_constant_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_font_override:

.. rst-class:: classref-method

void **remove_theme_font_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme :ref:`Font<class_Font>` with the specified ``name`` previously added by :ref:`add_theme_font_override<class_Window_method_add_theme_font_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_font_size_override:

.. rst-class:: classref-method

void **remove_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme font size with the specified ``name`` previously added by :ref:`add_theme_font_size_override<class_Window_method_add_theme_font_size_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_icon_override:

.. rst-class:: classref-method

void **remove_theme_icon_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme icon with the specified ``name`` previously added by :ref:`add_theme_icon_override<class_Window_method_add_theme_icon_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_remove_theme_stylebox_override:

.. rst-class:: classref-method

void **remove_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name **)**

Removes a local override for a theme :ref:`StyleBox<class_StyleBox>` with the specified ``name`` previously added by :ref:`add_theme_stylebox_override<class_Window_method_add_theme_stylebox_override>` or via the Inspector dock.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_request_attention:

.. rst-class:: classref-method

void **request_attention** **(** **)**

Tells the OS that the **Window** needs an attention. This makes the window stand out in some way depending on the system, e.g. it might blink on the task bar.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_reset_size:

.. rst-class:: classref-method

void **reset_size** **(** **)**

Resets the size to the minimum size, which is the max of :ref:`min_size<class_Window_property_min_size>` and (if :ref:`wrap_controls<class_Window_property_wrap_controls>` is enabled) :ref:`get_contents_minimum_size<class_Window_method_get_contents_minimum_size>`. This is equivalent to calling ``set_size(Vector2i())`` (or any size below the minimum).

.. rst-class:: classref-item-separator

----

.. _class_Window_method_set_flag:

.. rst-class:: classref-method

void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**

Sets a specified window flag.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_set_ime_active:

.. rst-class:: classref-method

void **set_ime_active** **(** :ref:`bool<class_bool>` active **)**

If ``active`` is ``true``, enables system's native IME (Input Method Editor).

.. rst-class:: classref-item-separator

----

.. _class_Window_method_set_ime_position:

.. rst-class:: classref-method

void **set_ime_position** **(** :ref:`Vector2i<class_Vector2i>` position **)**

Moves IME to the given position.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_set_layout_direction:

.. rst-class:: classref-method

void **set_layout_direction** **(** :ref:`LayoutDirection<enum_Window_LayoutDirection>` direction **)**

Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew).

.. rst-class:: classref-item-separator

----

.. _class_Window_method_set_use_font_oversampling:

.. rst-class:: classref-method

void **set_use_font_oversampling** **(** :ref:`bool<class_bool>` enable **)**

Enables font oversampling. This makes fonts look better when they are scaled up.

.. rst-class:: classref-item-separator

----

.. _class_Window_method_show:

.. rst-class:: classref-method

void **show** **(** **)**

Makes the **Window** appear. This enables interactions with the **Window** and doesn't change any of its property other than visibility (unlike e.g. :ref:`popup<class_Window_method_popup>`).

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Theme Property Descriptions
---------------------------

.. _class_Window_theme_color_title_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **title_color** = ``Color(0.875, 0.875, 0.875, 1)``

The color of the title's text.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_color_title_outline_modulate:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **title_outline_modulate** = ``Color(1, 1, 1, 1)``

The color of the title's text outline.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_constant_close_h_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **close_h_offset** = ``18``

Horizontal position offset of the close button.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_constant_close_v_offset:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **close_v_offset** = ``24``

Vertical position offset of the close button.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_constant_resize_margin:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **resize_margin** = ``4``

Defines the outside margin at which the window border can be grabbed with mouse and resized.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_constant_title_height:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **title_height** = ``36``

Height of the title bar.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_constant_title_outline_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **title_outline_size** = ``0``

The size of the title outline.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_font_title_font:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **title_font**

The font used to draw the title.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_font_size_title_font_size:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **title_font_size**

The size of the title font.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_icon_close:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **close**

The icon for the close button.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_icon_close_pressed:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **close_pressed**

The icon for the close button when it's being pressed.

.. rst-class:: classref-item-separator

----

.. _class_Window_theme_style_embedded_border:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **embedded_border**

The background style used when the **Window** is embedded. Note that this is drawn only under the window's content, excluding the title. For proper borders and title bar style, you can use ``expand_margin_*`` properties of :ref:`StyleBoxFlat<class_StyleBoxFlat>`.

\ **Note:** The content background will not be visible unless :ref:`transparent<class_Window_property_transparent>` is enabled.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`