class_window.rst 134 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Window.xml.
  6. .. _class_Window:
  7. Window
  8. ======
  9. **Inherits:** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AcceptDialog<class_AcceptDialog>`, :ref:`Popup<class_Popup>`
  11. Base class for all windows, dialogs, and popups.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. 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>`).
  16. At runtime, **Window**\ s will not close automatically when requested. You need to handle it manually using the :ref:`close_requested<class_Window_signal_close_requested>` signal (this applies both to pressing the close button and clicking outside of a popup).
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  22. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`always_on_top<class_Window_property_always_on_top>` | ``false`` |
  24. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`auto_translate<class_Window_property_auto_translate>` | ``true`` |
  26. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  27. | :ref:`bool<class_bool>` | :ref:`borderless<class_Window_property_borderless>` | ``false`` |
  28. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  29. | :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` | :ref:`content_scale_aspect<class_Window_property_content_scale_aspect>` | ``0`` |
  30. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  31. | :ref:`float<class_float>` | :ref:`content_scale_factor<class_Window_property_content_scale_factor>` | ``1.0`` |
  32. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  33. | :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` | :ref:`content_scale_mode<class_Window_property_content_scale_mode>` | ``0`` |
  34. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  35. | :ref:`Vector2i<class_Vector2i>` | :ref:`content_scale_size<class_Window_property_content_scale_size>` | ``Vector2i(0, 0)`` |
  36. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  37. | :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` | :ref:`content_scale_stretch<class_Window_property_content_scale_stretch>` | ``0`` |
  38. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  39. | :ref:`int<class_int>` | :ref:`current_screen<class_Window_property_current_screen>` | |
  40. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  41. | :ref:`bool<class_bool>` | :ref:`exclusive<class_Window_property_exclusive>` | ``false`` |
  42. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  43. | :ref:`bool<class_bool>` | :ref:`extend_to_title<class_Window_property_extend_to_title>` | ``false`` |
  44. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  45. | :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` | :ref:`initial_position<class_Window_property_initial_position>` | ``0`` |
  46. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  47. | :ref:`bool<class_bool>` | :ref:`keep_title_visible<class_Window_property_keep_title_visible>` | ``false`` |
  48. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  49. | :ref:`Vector2i<class_Vector2i>` | :ref:`max_size<class_Window_property_max_size>` | ``Vector2i(0, 0)`` |
  50. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  51. | :ref:`Vector2i<class_Vector2i>` | :ref:`min_size<class_Window_property_min_size>` | ``Vector2i(0, 0)`` |
  52. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  53. | :ref:`Mode<enum_Window_Mode>` | :ref:`mode<class_Window_property_mode>` | ``0`` |
  54. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`mouse_passthrough<class_Window_property_mouse_passthrough>` | ``false`` |
  56. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  57. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`mouse_passthrough_polygon<class_Window_property_mouse_passthrough_polygon>` | ``PackedVector2Array()`` |
  58. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  59. | :ref:`bool<class_bool>` | :ref:`popup_window<class_Window_property_popup_window>` | ``false`` |
  60. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  61. | :ref:`Vector2i<class_Vector2i>` | :ref:`position<class_Window_property_position>` | ``Vector2i(0, 0)`` |
  62. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  63. | :ref:`Vector2i<class_Vector2i>` | :ref:`size<class_Window_property_size>` | ``Vector2i(100, 100)`` |
  64. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  65. | :ref:`Theme<class_Theme>` | :ref:`theme<class_Window_property_theme>` | |
  66. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  67. | :ref:`StringName<class_StringName>` | :ref:`theme_type_variation<class_Window_property_theme_type_variation>` | ``&""`` |
  68. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  69. | :ref:`String<class_String>` | :ref:`title<class_Window_property_title>` | ``""`` |
  70. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  71. | :ref:`bool<class_bool>` | :ref:`transient<class_Window_property_transient>` | ``false`` |
  72. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  73. | :ref:`bool<class_bool>` | :ref:`transparent<class_Window_property_transparent>` | ``false`` |
  74. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  75. | :ref:`bool<class_bool>` | :ref:`unfocusable<class_Window_property_unfocusable>` | ``false`` |
  76. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  77. | :ref:`bool<class_bool>` | :ref:`unresizable<class_Window_property_unresizable>` | ``false`` |
  78. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  79. | :ref:`bool<class_bool>` | :ref:`visible<class_Window_property_visible>` | ``true`` |
  80. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`wrap_controls<class_Window_property_wrap_controls>` | ``false`` |
  82. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------+--------------------------+
  83. .. rst-class:: classref-reftable-group
  84. Methods
  85. -------
  86. .. table::
  87. :widths: auto
  88. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`Vector2<class_Vector2>` | :ref:`_get_contents_minimum_size<class_Window_private_method__get_contents_minimum_size>` **(** **)** |virtual| |const| |
  90. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`add_theme_color_override<class_Window_method_add_theme_color_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)** |
  92. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`add_theme_constant_override<class_Window_method_add_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)** |
  94. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`add_theme_font_override<class_Window_method_add_theme_font_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)** |
  96. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | 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 **)** |
  98. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`add_theme_icon_override<class_Window_method_add_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)** |
  100. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`add_theme_stylebox_override<class_Window_method_add_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)** |
  102. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`begin_bulk_theme_override<class_Window_method_begin_bulk_theme_override>` **(** **)** |
  104. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`bool<class_bool>` | :ref:`can_draw<class_Window_method_can_draw>` **(** **)** |const| |
  106. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | void | :ref:`child_controls_changed<class_Window_method_child_controls_changed>` **(** **)** |
  108. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | void | :ref:`end_bulk_theme_override<class_Window_method_end_bulk_theme_override>` **(** **)** |
  110. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`Vector2<class_Vector2>` | :ref:`get_contents_minimum_size<class_Window_method_get_contents_minimum_size>` **(** **)** |const| |
  112. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`bool<class_bool>` | :ref:`get_flag<class_Window_method_get_flag>` **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const| |
  114. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`LayoutDirection<enum_Window_LayoutDirection>` | :ref:`get_layout_direction<class_Window_method_get_layout_direction>` **(** **)** |const| |
  116. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Vector2i<class_Vector2i>` | :ref:`get_position_with_decorations<class_Window_method_get_position_with_decorations>` **(** **)** |const| |
  118. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`Vector2i<class_Vector2i>` | :ref:`get_size_with_decorations<class_Window_method_get_size_with_decorations>` **(** **)** |const| |
  120. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :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| |
  122. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :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| |
  124. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`float<class_float>` | :ref:`get_theme_default_base_scale<class_Window_method_get_theme_default_base_scale>` **(** **)** |const| |
  126. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Font<class_Font>` | :ref:`get_theme_default_font<class_Window_method_get_theme_default_font>` **(** **)** |const| |
  128. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`int<class_int>` | :ref:`get_theme_default_font_size<class_Window_method_get_theme_default_font_size>` **(** **)** |const| |
  130. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :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| |
  132. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :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| |
  134. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :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| |
  136. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :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| |
  138. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`int<class_int>` | :ref:`get_window_id<class_Window_method_get_window_id>` **(** **)** |const| |
  140. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`grab_focus<class_Window_method_grab_focus>` **(** **)** |
  142. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`has_focus<class_Window_method_has_focus>` **(** **)** |const| |
  144. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :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| |
  146. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`bool<class_bool>` | :ref:`has_theme_color_override<class_Window_method_has_theme_color_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  148. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :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| |
  150. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`bool<class_bool>` | :ref:`has_theme_constant_override<class_Window_method_has_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  152. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :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| |
  154. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`bool<class_bool>` | :ref:`has_theme_font_override<class_Window_method_has_theme_font_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  156. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :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| |
  158. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`bool<class_bool>` | :ref:`has_theme_font_size_override<class_Window_method_has_theme_font_size_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  160. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :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| |
  162. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`bool<class_bool>` | :ref:`has_theme_icon_override<class_Window_method_has_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  164. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :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| |
  166. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`bool<class_bool>` | :ref:`has_theme_stylebox_override<class_Window_method_has_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  168. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | void | :ref:`hide<class_Window_method_hide>` **(** **)** |
  170. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`bool<class_bool>` | :ref:`is_embedded<class_Window_method_is_embedded>` **(** **)** |const| |
  172. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`bool<class_bool>` | :ref:`is_layout_rtl<class_Window_method_is_layout_rtl>` **(** **)** |const| |
  174. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`bool<class_bool>` | :ref:`is_maximize_allowed<class_Window_method_is_maximize_allowed>` **(** **)** |const| |
  176. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :ref:`bool<class_bool>` | :ref:`is_using_font_oversampling<class_Window_method_is_using_font_oversampling>` **(** **)** |const| |
  178. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`move_to_center<class_Window_method_move_to_center>` **(** **)** |
  180. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | void | :ref:`move_to_foreground<class_Window_method_move_to_foreground>` **(** **)** |
  182. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | void | :ref:`popup<class_Window_method_popup>` **(** :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)** |
  184. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | void | :ref:`popup_centered<class_Window_method_popup_centered>` **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)** |
  186. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | 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 **)** |
  188. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | void | :ref:`popup_centered_ratio<class_Window_method_popup_centered_ratio>` **(** :ref:`float<class_float>` ratio=0.8 **)** |
  190. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | void | :ref:`popup_exclusive<class_Window_method_popup_exclusive>` **(** :ref:`Node<class_Node>` from_node, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)** |
  192. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | void | :ref:`popup_exclusive_centered<class_Window_method_popup_exclusive_centered>` **(** :ref:`Node<class_Node>` from_node, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)** |
  194. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | void | :ref:`popup_exclusive_centered_clamped<class_Window_method_popup_exclusive_centered_clamped>` **(** :ref:`Node<class_Node>` from_node, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)** |
  196. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | void | :ref:`popup_exclusive_centered_ratio<class_Window_method_popup_exclusive_centered_ratio>` **(** :ref:`Node<class_Node>` from_node, :ref:`float<class_float>` ratio=0.8 **)** |
  198. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | void | :ref:`popup_exclusive_on_parent<class_Window_method_popup_exclusive_on_parent>` **(** :ref:`Node<class_Node>` from_node, :ref:`Rect2i<class_Rect2i>` parent_rect **)** |
  200. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`popup_on_parent<class_Window_method_popup_on_parent>` **(** :ref:`Rect2i<class_Rect2i>` parent_rect **)** |
  202. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | void | :ref:`remove_theme_color_override<class_Window_method_remove_theme_color_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  204. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | void | :ref:`remove_theme_constant_override<class_Window_method_remove_theme_constant_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  206. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`remove_theme_font_override<class_Window_method_remove_theme_font_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  208. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | void | :ref:`remove_theme_font_size_override<class_Window_method_remove_theme_font_size_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  210. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | void | :ref:`remove_theme_icon_override<class_Window_method_remove_theme_icon_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  212. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`remove_theme_stylebox_override<class_Window_method_remove_theme_stylebox_override>` **(** :ref:`StringName<class_StringName>` name **)** |
  214. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | void | :ref:`request_attention<class_Window_method_request_attention>` **(** **)** |
  216. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | void | :ref:`reset_size<class_Window_method_reset_size>` **(** **)** |
  218. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | void | :ref:`set_flag<class_Window_method_set_flag>` **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)** |
  220. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | void | :ref:`set_ime_active<class_Window_method_set_ime_active>` **(** :ref:`bool<class_bool>` active **)** |
  222. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | void | :ref:`set_ime_position<class_Window_method_set_ime_position>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |
  224. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | void | :ref:`set_layout_direction<class_Window_method_set_layout_direction>` **(** :ref:`LayoutDirection<enum_Window_LayoutDirection>` direction **)** |
  226. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | void | :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` **(** :ref:`bool<class_bool>` unparent **)** |
  228. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | void | :ref:`set_use_font_oversampling<class_Window_method_set_use_font_oversampling>` **(** :ref:`bool<class_bool>` enable **)** |
  230. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | void | :ref:`show<class_Window_method_show>` **(** **)** |
  232. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. .. rst-class:: classref-reftable-group
  234. Theme Properties
  235. ----------------
  236. .. table::
  237. :widths: auto
  238. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  239. | :ref:`Color<class_Color>` | :ref:`title_color<class_Window_theme_color_title_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
  240. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  241. | :ref:`Color<class_Color>` | :ref:`title_outline_modulate<class_Window_theme_color_title_outline_modulate>` | ``Color(1, 1, 1, 1)`` |
  242. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  243. | :ref:`int<class_int>` | :ref:`close_h_offset<class_Window_theme_constant_close_h_offset>` | ``18`` |
  244. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  245. | :ref:`int<class_int>` | :ref:`close_v_offset<class_Window_theme_constant_close_v_offset>` | ``24`` |
  246. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  247. | :ref:`int<class_int>` | :ref:`resize_margin<class_Window_theme_constant_resize_margin>` | ``4`` |
  248. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  249. | :ref:`int<class_int>` | :ref:`title_height<class_Window_theme_constant_title_height>` | ``36`` |
  250. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  251. | :ref:`int<class_int>` | :ref:`title_outline_size<class_Window_theme_constant_title_outline_size>` | ``0`` |
  252. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  253. | :ref:`Font<class_Font>` | :ref:`title_font<class_Window_theme_font_title_font>` | |
  254. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  255. | :ref:`int<class_int>` | :ref:`title_font_size<class_Window_theme_font_size_title_font_size>` | |
  256. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  257. | :ref:`Texture2D<class_Texture2D>` | :ref:`close<class_Window_theme_icon_close>` | |
  258. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  259. | :ref:`Texture2D<class_Texture2D>` | :ref:`close_pressed<class_Window_theme_icon_close_pressed>` | |
  260. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  261. | :ref:`StyleBox<class_StyleBox>` | :ref:`embedded_border<class_Window_theme_style_embedded_border>` | |
  262. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  263. | :ref:`StyleBox<class_StyleBox>` | :ref:`embedded_unfocused_border<class_Window_theme_style_embedded_unfocused_border>` | |
  264. +-----------------------------------+--------------------------------------------------------------------------------------+-----------------------------------+
  265. .. rst-class:: classref-section-separator
  266. ----
  267. .. rst-class:: classref-descriptions-group
  268. Signals
  269. -------
  270. .. _class_Window_signal_about_to_popup:
  271. .. rst-class:: classref-signal
  272. **about_to_popup** **(** **)**
  273. Emitted right after :ref:`popup<class_Window_method_popup>` call, before the **Window** appears or does anything.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_Window_signal_close_requested:
  277. .. rst-class:: classref-signal
  278. **close_requested** **(** **)**
  279. 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.
  280. This signal can be used to handle window closing, e.g. by connecting it to :ref:`hide<class_Window_method_hide>`.
  281. .. rst-class:: classref-item-separator
  282. ----
  283. .. _class_Window_signal_dpi_changed:
  284. .. rst-class:: classref-signal
  285. **dpi_changed** **(** **)**
  286. 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).
  287. \ **Note:** Only implemented on macOS.
  288. .. rst-class:: classref-item-separator
  289. ----
  290. .. _class_Window_signal_files_dropped:
  291. .. rst-class:: classref-signal
  292. **files_dropped** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**
  293. Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths.
  294. Note that this method only works with native 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.
  295. Example usage:
  296. ::
  297. func _ready():
  298. get_viewport().files_dropped.connect(on_files_dropped)
  299. func on_files_dropped(files):
  300. print(files)
  301. .. rst-class:: classref-item-separator
  302. ----
  303. .. _class_Window_signal_focus_entered:
  304. .. rst-class:: classref-signal
  305. **focus_entered** **(** **)**
  306. Emitted when the **Window** gains focus.
  307. .. rst-class:: classref-item-separator
  308. ----
  309. .. _class_Window_signal_focus_exited:
  310. .. rst-class:: classref-signal
  311. **focus_exited** **(** **)**
  312. Emitted when the **Window** loses its focus.
  313. .. rst-class:: classref-item-separator
  314. ----
  315. .. _class_Window_signal_go_back_requested:
  316. .. rst-class:: classref-signal
  317. **go_back_requested** **(** **)**
  318. 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>`.
  319. .. rst-class:: classref-item-separator
  320. ----
  321. .. _class_Window_signal_mouse_entered:
  322. .. rst-class:: classref-signal
  323. **mouse_entered** **(** **)**
  324. Emitted when the mouse cursor enters the **Window**'s visible area, that is not occluded behind other :ref:`Control<class_Control>`\ s or windows, provided its :ref:`Viewport.gui_disable_input<class_Viewport_property_gui_disable_input>` is ``false`` and regardless if it's currently focused or not.
  325. .. rst-class:: classref-item-separator
  326. ----
  327. .. _class_Window_signal_mouse_exited:
  328. .. rst-class:: classref-signal
  329. **mouse_exited** **(** **)**
  330. Emitted when the mouse cursor leaves the **Window**'s visible area, that is not occluded behind other :ref:`Control<class_Control>`\ s or windows, provided its :ref:`Viewport.gui_disable_input<class_Viewport_property_gui_disable_input>` is ``false`` and regardless if it's currently focused or not.
  331. .. rst-class:: classref-item-separator
  332. ----
  333. .. _class_Window_signal_theme_changed:
  334. .. rst-class:: classref-signal
  335. **theme_changed** **(** **)**
  336. Emitted when the :ref:`NOTIFICATION_THEME_CHANGED<class_Window_constant_NOTIFICATION_THEME_CHANGED>` notification is sent.
  337. .. rst-class:: classref-item-separator
  338. ----
  339. .. _class_Window_signal_titlebar_changed:
  340. .. rst-class:: classref-signal
  341. **titlebar_changed** **(** **)**
  342. Emitted when window title bar decorations are changed, e.g. macOS window enter/exit full screen mode, or extend-to-title flag is changed.
  343. .. rst-class:: classref-item-separator
  344. ----
  345. .. _class_Window_signal_visibility_changed:
  346. .. rst-class:: classref-signal
  347. **visibility_changed** **(** **)**
  348. Emitted when **Window** is made visible or disappears.
  349. .. rst-class:: classref-item-separator
  350. ----
  351. .. _class_Window_signal_window_input:
  352. .. rst-class:: classref-signal
  353. **window_input** **(** :ref:`InputEvent<class_InputEvent>` event **)**
  354. 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.
  355. .. rst-class:: classref-section-separator
  356. ----
  357. .. rst-class:: classref-descriptions-group
  358. Enumerations
  359. ------------
  360. .. _enum_Window_Mode:
  361. .. rst-class:: classref-enumeration
  362. enum **Mode**:
  363. .. _class_Window_constant_MODE_WINDOWED:
  364. .. rst-class:: classref-enumeration-constant
  365. :ref:`Mode<enum_Window_Mode>` **MODE_WINDOWED** = ``0``
  366. Windowed mode, i.e. **Window** doesn't occupy the whole screen (unless set to the size of the screen).
  367. .. _class_Window_constant_MODE_MINIMIZED:
  368. .. rst-class:: classref-enumeration-constant
  369. :ref:`Mode<enum_Window_Mode>` **MODE_MINIMIZED** = ``1``
  370. 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.
  371. .. _class_Window_constant_MODE_MAXIMIZED:
  372. .. rst-class:: classref-enumeration-constant
  373. :ref:`Mode<enum_Window_Mode>` **MODE_MAXIMIZED** = ``2``
  374. 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.
  375. .. _class_Window_constant_MODE_FULLSCREEN:
  376. .. rst-class:: classref-enumeration-constant
  377. :ref:`Mode<enum_Window_Mode>` **MODE_FULLSCREEN** = ``3``
  378. Full screen mode with full multi-window support.
  379. Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed.
  380. \ **On Windows:** Multi-window full-screen mode has a 1px border of the :ref:`ProjectSettings.rendering/environment/defaults/default_clear_color<class_ProjectSettings_property_rendering/environment/defaults/default_clear_color>` color.
  381. \ **On macOS:** A new desktop is used to display the running project.
  382. \ **Note:** 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.
  383. .. _class_Window_constant_MODE_EXCLUSIVE_FULLSCREEN:
  384. .. rst-class:: classref-enumeration-constant
  385. :ref:`Mode<enum_Window_Mode>` **MODE_EXCLUSIVE_FULLSCREEN** = ``4``
  386. A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition).
  387. Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
  388. \ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
  389. \ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
  390. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
  391. \ **Note:** 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.
  392. .. rst-class:: classref-item-separator
  393. ----
  394. .. _enum_Window_Flags:
  395. .. rst-class:: classref-enumeration
  396. enum **Flags**:
  397. .. _class_Window_constant_FLAG_RESIZE_DISABLED:
  398. .. rst-class:: classref-enumeration-constant
  399. :ref:`Flags<enum_Window_Flags>` **FLAG_RESIZE_DISABLED** = ``0``
  400. The window can't be resized 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>`.
  401. .. _class_Window_constant_FLAG_BORDERLESS:
  402. .. rst-class:: classref-enumeration-constant
  403. :ref:`Flags<enum_Window_Flags>` **FLAG_BORDERLESS** = ``1``
  404. 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>`.
  405. .. _class_Window_constant_FLAG_ALWAYS_ON_TOP:
  406. .. rst-class:: classref-enumeration-constant
  407. :ref:`Flags<enum_Window_Flags>` **FLAG_ALWAYS_ON_TOP** = ``2``
  408. 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>`.
  409. .. _class_Window_constant_FLAG_TRANSPARENT:
  410. .. rst-class:: classref-enumeration-constant
  411. :ref:`Flags<enum_Window_Flags>` **FLAG_TRANSPARENT** = ``3``
  412. The window background can be transparent. Set with :ref:`transparent<class_Window_property_transparent>`.
  413. \ **Note:** This flag has no effect if either :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`, or the window's :ref:`Viewport.transparent_bg<class_Viewport_property_transparent_bg>` is set to ``false``.
  414. .. _class_Window_constant_FLAG_NO_FOCUS:
  415. .. rst-class:: classref-enumeration-constant
  416. :ref:`Flags<enum_Window_Flags>` **FLAG_NO_FOCUS** = ``4``
  417. The window can't be focused. No-focus window will ignore all input, except mouse clicks. Set with :ref:`unfocusable<class_Window_property_unfocusable>`.
  418. .. _class_Window_constant_FLAG_POPUP:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`Flags<enum_Window_Flags>` **FLAG_POPUP** = ``5``
  421. 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>`).
  422. \ **Note:** This flag has no effect in embedded windows (unless said window is a :ref:`Popup<class_Popup>`).
  423. .. _class_Window_constant_FLAG_EXTEND_TO_TITLE:
  424. .. rst-class:: classref-enumeration-constant
  425. :ref:`Flags<enum_Window_Flags>` **FLAG_EXTEND_TO_TITLE** = ``6``
  426. 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>`.
  427. \ **Note:** This flag is implemented only on macOS.
  428. \ **Note:** This flag has no effect in embedded windows.
  429. .. _class_Window_constant_FLAG_MOUSE_PASSTHROUGH:
  430. .. rst-class:: classref-enumeration-constant
  431. :ref:`Flags<enum_Window_Flags>` **FLAG_MOUSE_PASSTHROUGH** = ``7``
  432. All mouse events are passed to the underlying window of the same application.
  433. \ **Note:** This flag has no effect in embedded windows.
  434. .. _class_Window_constant_FLAG_MAX:
  435. .. rst-class:: classref-enumeration-constant
  436. :ref:`Flags<enum_Window_Flags>` **FLAG_MAX** = ``8``
  437. Max value of the :ref:`Flags<enum_Window_Flags>`.
  438. .. rst-class:: classref-item-separator
  439. ----
  440. .. _enum_Window_ContentScaleMode:
  441. .. rst-class:: classref-enumeration
  442. enum **ContentScaleMode**:
  443. .. _class_Window_constant_CONTENT_SCALE_MODE_DISABLED:
  444. .. rst-class:: classref-enumeration-constant
  445. :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_DISABLED** = ``0``
  446. The content will not be scaled to match the **Window**'s size.
  447. .. _class_Window_constant_CONTENT_SCALE_MODE_CANVAS_ITEMS:
  448. .. rst-class:: classref-enumeration-constant
  449. :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_CANVAS_ITEMS** = ``1``
  450. 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.
  451. .. _class_Window_constant_CONTENT_SCALE_MODE_VIEWPORT:
  452. .. rst-class:: classref-enumeration-constant
  453. :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **CONTENT_SCALE_MODE_VIEWPORT** = ``2``
  454. 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.
  455. .. rst-class:: classref-item-separator
  456. ----
  457. .. _enum_Window_ContentScaleAspect:
  458. .. rst-class:: classref-enumeration
  459. enum **ContentScaleAspect**:
  460. .. _class_Window_constant_CONTENT_SCALE_ASPECT_IGNORE:
  461. .. rst-class:: classref-enumeration-constant
  462. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_IGNORE** = ``0``
  463. The aspect will be ignored. Scaling will simply stretch the content to fit the target size.
  464. .. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP:
  465. .. rst-class:: classref-enumeration-constant
  466. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP** = ``1``
  467. 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.
  468. .. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP_WIDTH:
  469. .. rst-class:: classref-enumeration-constant
  470. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP_WIDTH** = ``2``
  471. The content can be expanded vertically. Scaling horizontally will result in keeping the width ratio and then black bars on left and right sides.
  472. .. _class_Window_constant_CONTENT_SCALE_ASPECT_KEEP_HEIGHT:
  473. .. rst-class:: classref-enumeration-constant
  474. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_KEEP_HEIGHT** = ``3``
  475. The content can be expanded horizontally. Scaling vertically will result in keeping the height ratio and then black bars on top and bottom sides.
  476. .. _class_Window_constant_CONTENT_SCALE_ASPECT_EXPAND:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **CONTENT_SCALE_ASPECT_EXPAND** = ``4``
  479. The content's aspect will be preserved. If the target size has different aspect from the base one, the content will stay in the top-left corner and add an extra visible area in the stretched space.
  480. .. rst-class:: classref-item-separator
  481. ----
  482. .. _enum_Window_ContentScaleStretch:
  483. .. rst-class:: classref-enumeration
  484. enum **ContentScaleStretch**:
  485. .. _class_Window_constant_CONTENT_SCALE_STRETCH_FRACTIONAL:
  486. .. rst-class:: classref-enumeration-constant
  487. :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` **CONTENT_SCALE_STRETCH_FRACTIONAL** = ``0``
  488. The content will be stretched according to a fractional factor. This fills all the space available in the window, but allows "pixel wobble" to occur due to uneven pixel scaling.
  489. .. _class_Window_constant_CONTENT_SCALE_STRETCH_INTEGER:
  490. .. rst-class:: classref-enumeration-constant
  491. :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` **CONTENT_SCALE_STRETCH_INTEGER** = ``1``
  492. The content will be stretched only according to an integer factor, preserving sharp pixels. This may leave a black background visible on the window's edges depending on the window size.
  493. .. rst-class:: classref-item-separator
  494. ----
  495. .. _enum_Window_LayoutDirection:
  496. .. rst-class:: classref-enumeration
  497. enum **LayoutDirection**:
  498. .. _class_Window_constant_LAYOUT_DIRECTION_INHERITED:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_INHERITED** = ``0``
  501. Automatic layout direction, determined from the parent window layout direction.
  502. .. _class_Window_constant_LAYOUT_DIRECTION_LOCALE:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_LOCALE** = ``1``
  505. Automatic layout direction, determined from the current locale.
  506. .. _class_Window_constant_LAYOUT_DIRECTION_LTR:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_LTR** = ``2``
  509. Left-to-right layout direction.
  510. .. _class_Window_constant_LAYOUT_DIRECTION_RTL:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`LayoutDirection<enum_Window_LayoutDirection>` **LAYOUT_DIRECTION_RTL** = ``3``
  513. Right-to-left layout direction.
  514. .. rst-class:: classref-item-separator
  515. ----
  516. .. _enum_Window_WindowInitialPosition:
  517. .. rst-class:: classref-enumeration
  518. enum **WindowInitialPosition**:
  519. .. _class_Window_constant_WINDOW_INITIAL_POSITION_ABSOLUTE:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_ABSOLUTE** = ``0``
  522. Initial window position is determined by :ref:`position<class_Window_property_position>`.
  523. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN:
  524. .. rst-class:: classref-enumeration-constant
  525. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_PRIMARY_SCREEN** = ``1``
  526. Initial window position is the center of the primary screen.
  527. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN:
  528. .. rst-class:: classref-enumeration-constant
  529. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_MAIN_WINDOW_SCREEN** = ``2``
  530. Initial window position is the center of the main window screen.
  531. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN:
  532. .. rst-class:: classref-enumeration-constant
  533. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_OTHER_SCREEN** = ``3``
  534. Initial window position is the center of :ref:`current_screen<class_Window_property_current_screen>` screen.
  535. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_MOUSE_FOCUS:
  536. .. rst-class:: classref-enumeration-constant
  537. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_MOUSE_FOCUS** = ``4``
  538. Initial window position is the center of the screen containing the mouse pointer.
  539. .. _class_Window_constant_WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_KEYBOARD_FOCUS:
  540. .. rst-class:: classref-enumeration-constant
  541. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **WINDOW_INITIAL_POSITION_CENTER_SCREEN_WITH_KEYBOARD_FOCUS** = ``5``
  542. Initial window position is the center of the screen containing the window with the keyboard focus.
  543. .. rst-class:: classref-section-separator
  544. ----
  545. .. rst-class:: classref-descriptions-group
  546. Constants
  547. ---------
  548. .. _class_Window_constant_NOTIFICATION_VISIBILITY_CHANGED:
  549. .. rst-class:: classref-constant
  550. **NOTIFICATION_VISIBILITY_CHANGED** = ``30``
  551. Emitted when **Window**'s visibility changes, right before :ref:`visibility_changed<class_Window_signal_visibility_changed>`.
  552. .. _class_Window_constant_NOTIFICATION_THEME_CHANGED:
  553. .. rst-class:: classref-constant
  554. **NOTIFICATION_THEME_CHANGED** = ``32``
  555. Sent when the node needs to refresh its theme items. This happens in one of the following cases:
  556. - The :ref:`theme<class_Window_property_theme>` property is changed on this node or any of its ancestors.
  557. - The :ref:`theme_type_variation<class_Window_property_theme_type_variation>` property is changed on this node.
  558. - The node enters the scene tree.
  559. \ **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.
  560. .. rst-class:: classref-section-separator
  561. ----
  562. .. rst-class:: classref-descriptions-group
  563. Property Descriptions
  564. ---------------------
  565. .. _class_Window_property_always_on_top:
  566. .. rst-class:: classref-property
  567. :ref:`bool<class_bool>` **always_on_top** = ``false``
  568. .. rst-class:: classref-property-setget
  569. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  570. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  571. If ``true``, the window will be on top of all other windows. Does not work if :ref:`transient<class_Window_property_transient>` is enabled.
  572. .. rst-class:: classref-item-separator
  573. ----
  574. .. _class_Window_property_auto_translate:
  575. .. rst-class:: classref-property
  576. :ref:`bool<class_bool>` **auto_translate** = ``true``
  577. .. rst-class:: classref-property-setget
  578. - void **set_auto_translate** **(** :ref:`bool<class_bool>` value **)**
  579. - :ref:`bool<class_bool>` **is_auto_translating** **(** **)**
  580. Toggles if any text should automatically change to its translated version depending on the current locale.
  581. .. rst-class:: classref-item-separator
  582. ----
  583. .. _class_Window_property_borderless:
  584. .. rst-class:: classref-property
  585. :ref:`bool<class_bool>` **borderless** = ``false``
  586. .. rst-class:: classref-property-setget
  587. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  588. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  589. If ``true``, the window will have no borders.
  590. .. rst-class:: classref-item-separator
  591. ----
  592. .. _class_Window_property_content_scale_aspect:
  593. .. rst-class:: classref-property
  594. :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **content_scale_aspect** = ``0``
  595. .. rst-class:: classref-property-setget
  596. - void **set_content_scale_aspect** **(** :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` value **)**
  597. - :ref:`ContentScaleAspect<enum_Window_ContentScaleAspect>` **get_content_scale_aspect** **(** **)**
  598. 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>`.
  599. .. rst-class:: classref-item-separator
  600. ----
  601. .. _class_Window_property_content_scale_factor:
  602. .. rst-class:: classref-property
  603. :ref:`float<class_float>` **content_scale_factor** = ``1.0``
  604. .. rst-class:: classref-property-setget
  605. - void **set_content_scale_factor** **(** :ref:`float<class_float>` value **)**
  606. - :ref:`float<class_float>` **get_content_scale_factor** **(** **)**
  607. 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>`.
  608. .. rst-class:: classref-item-separator
  609. ----
  610. .. _class_Window_property_content_scale_mode:
  611. .. rst-class:: classref-property
  612. :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **content_scale_mode** = ``0``
  613. .. rst-class:: classref-property-setget
  614. - void **set_content_scale_mode** **(** :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` value **)**
  615. - :ref:`ContentScaleMode<enum_Window_ContentScaleMode>` **get_content_scale_mode** **(** **)**
  616. Specifies how the content is scaled when the **Window** is resized.
  617. .. rst-class:: classref-item-separator
  618. ----
  619. .. _class_Window_property_content_scale_size:
  620. .. rst-class:: classref-property
  621. :ref:`Vector2i<class_Vector2i>` **content_scale_size** = ``Vector2i(0, 0)``
  622. .. rst-class:: classref-property-setget
  623. - void **set_content_scale_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
  624. - :ref:`Vector2i<class_Vector2i>` **get_content_scale_size** **(** **)**
  625. 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.
  626. .. rst-class:: classref-item-separator
  627. ----
  628. .. _class_Window_property_content_scale_stretch:
  629. .. rst-class:: classref-property
  630. :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` **content_scale_stretch** = ``0``
  631. .. rst-class:: classref-property-setget
  632. - void **set_content_scale_stretch** **(** :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` value **)**
  633. - :ref:`ContentScaleStretch<enum_Window_ContentScaleStretch>` **get_content_scale_stretch** **(** **)**
  634. The policy to use to determine the final scale factor for 2D elements. This affects how :ref:`content_scale_factor<class_Window_property_content_scale_factor>` is applied, in addition to the automatic scale factor determined by :ref:`content_scale_size<class_Window_property_content_scale_size>`.
  635. .. rst-class:: classref-item-separator
  636. ----
  637. .. _class_Window_property_current_screen:
  638. .. rst-class:: classref-property
  639. :ref:`int<class_int>` **current_screen**
  640. .. rst-class:: classref-property-setget
  641. - void **set_current_screen** **(** :ref:`int<class_int>` value **)**
  642. - :ref:`int<class_int>` **get_current_screen** **(** **)**
  643. The screen the window is currently on.
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _class_Window_property_exclusive:
  647. .. rst-class:: classref-property
  648. :ref:`bool<class_bool>` **exclusive** = ``false``
  649. .. rst-class:: classref-property-setget
  650. - void **set_exclusive** **(** :ref:`bool<class_bool>` value **)**
  651. - :ref:`bool<class_bool>` **is_exclusive** **(** **)**
  652. 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**.
  653. Needs :ref:`transient<class_Window_property_transient>` enabled to work.
  654. .. rst-class:: classref-item-separator
  655. ----
  656. .. _class_Window_property_extend_to_title:
  657. .. rst-class:: classref-property
  658. :ref:`bool<class_bool>` **extend_to_title** = ``false``
  659. .. rst-class:: classref-property-setget
  660. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  661. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  662. If ``true``, the **Window** contents is expanded to the full size of the window, window title bar is transparent.
  663. \ **Note:** This property is implemented only on macOS.
  664. \ **Note:** This property only works with native windows.
  665. .. rst-class:: classref-item-separator
  666. ----
  667. .. _class_Window_property_initial_position:
  668. .. rst-class:: classref-property
  669. :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **initial_position** = ``0``
  670. .. rst-class:: classref-property-setget
  671. - void **set_initial_position** **(** :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` value **)**
  672. - :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` **get_initial_position** **(** **)**
  673. Specifies the initial type of position for the **Window**. See :ref:`WindowInitialPosition<enum_Window_WindowInitialPosition>` constants.
  674. .. rst-class:: classref-item-separator
  675. ----
  676. .. _class_Window_property_keep_title_visible:
  677. .. rst-class:: classref-property
  678. :ref:`bool<class_bool>` **keep_title_visible** = ``false``
  679. .. rst-class:: classref-property-setget
  680. - void **set_keep_title_visible** **(** :ref:`bool<class_bool>` value **)**
  681. - :ref:`bool<class_bool>` **get_keep_title_visible** **(** **)**
  682. If ``true``, the **Window** width is expanded to keep the title bar text fully visible.
  683. .. rst-class:: classref-item-separator
  684. ----
  685. .. _class_Window_property_max_size:
  686. .. rst-class:: classref-property
  687. :ref:`Vector2i<class_Vector2i>` **max_size** = ``Vector2i(0, 0)``
  688. .. rst-class:: classref-property-setget
  689. - void **set_max_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
  690. - :ref:`Vector2i<class_Vector2i>` **get_max_size** **(** **)**
  691. If non-zero, the **Window** can't be resized to be bigger than this size.
  692. \ **Note:** This property will be ignored if the value is lower than :ref:`min_size<class_Window_property_min_size>`.
  693. .. rst-class:: classref-item-separator
  694. ----
  695. .. _class_Window_property_min_size:
  696. .. rst-class:: classref-property
  697. :ref:`Vector2i<class_Vector2i>` **min_size** = ``Vector2i(0, 0)``
  698. .. rst-class:: classref-property-setget
  699. - void **set_min_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
  700. - :ref:`Vector2i<class_Vector2i>` **get_min_size** **(** **)**
  701. If non-zero, the **Window** can't be resized to be smaller than this size.
  702. \ **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.
  703. .. rst-class:: classref-item-separator
  704. ----
  705. .. _class_Window_property_mode:
  706. .. rst-class:: classref-property
  707. :ref:`Mode<enum_Window_Mode>` **mode** = ``0``
  708. .. rst-class:: classref-property-setget
  709. - void **set_mode** **(** :ref:`Mode<enum_Window_Mode>` value **)**
  710. - :ref:`Mode<enum_Window_Mode>` **get_mode** **(** **)**
  711. Set's the window's current mode.
  712. \ **Note:** Fullscreen mode is not exclusive full screen on Windows and Linux.
  713. \ **Note:** This method only works with native 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.
  714. .. rst-class:: classref-item-separator
  715. ----
  716. .. _class_Window_property_mouse_passthrough:
  717. .. rst-class:: classref-property
  718. :ref:`bool<class_bool>` **mouse_passthrough** = ``false``
  719. .. rst-class:: classref-property-setget
  720. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  721. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  722. If ``true``, all mouse events will be passed to the underlying window of the same application. See also :ref:`mouse_passthrough_polygon<class_Window_property_mouse_passthrough_polygon>`.
  723. \ **Note:** This property is implemented on Linux (X11), macOS and Windows.
  724. \ **Note:** This property only works with native windows.
  725. .. rst-class:: classref-item-separator
  726. ----
  727. .. _class_Window_property_mouse_passthrough_polygon:
  728. .. rst-class:: classref-property
  729. :ref:`PackedVector2Array<class_PackedVector2Array>` **mouse_passthrough_polygon** = ``PackedVector2Array()``
  730. .. rst-class:: classref-property-setget
  731. - void **set_mouse_passthrough_polygon** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` value **)**
  732. - :ref:`PackedVector2Array<class_PackedVector2Array>` **get_mouse_passthrough_polygon** **(** **)**
  733. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
  734. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
  735. .. tabs::
  736. .. code-tab:: gdscript
  737. # Set region, using Path2D node.
  738. $Window.mouse_passthrough_polygon = $Path2D.curve.get_baked_points()
  739. # Set region, using Polygon2D node.
  740. $Window.mouse_passthrough_polygon = $Polygon2D.polygon
  741. # Reset region to default.
  742. $Window.mouse_passthrough_polygon = []
  743. .. code-tab:: csharp
  744. // Set region, using Path2D node.
  745. GetNode<Window>("Window").MousePassthrough = GetNode<Path2D>("Path2D").Curve.GetBakedPoints();
  746. // Set region, using Polygon2D node.
  747. GetNode<Window>("Window").MousePassthrough = GetNode<Polygon2D>("Polygon2D").Polygon;
  748. // Reset region to default.
  749. GetNode<Window>("Window").MousePassthrough = new Vector2[] {};
  750. \ **Note:** This property is ignored if :ref:`mouse_passthrough<class_Window_property_mouse_passthrough>` is set to ``true``.
  751. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
  752. \ **Note:** This property is implemented on Linux (X11), macOS and Windows.
  753. .. rst-class:: classref-item-separator
  754. ----
  755. .. _class_Window_property_popup_window:
  756. .. rst-class:: classref-property
  757. :ref:`bool<class_bool>` **popup_window** = ``false``
  758. .. rst-class:: classref-property-setget
  759. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  760. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  761. 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).
  762. .. rst-class:: classref-item-separator
  763. ----
  764. .. _class_Window_property_position:
  765. .. rst-class:: classref-property
  766. :ref:`Vector2i<class_Vector2i>` **position** = ``Vector2i(0, 0)``
  767. .. rst-class:: classref-property-setget
  768. - void **set_position** **(** :ref:`Vector2i<class_Vector2i>` value **)**
  769. - :ref:`Vector2i<class_Vector2i>` **get_position** **(** **)**
  770. The window's position in pixels.
  771. If :ref:`ProjectSettings.display/window/subwindows/embed_subwindows<class_ProjectSettings_property_display/window/subwindows/embed_subwindows>` is ``false``, the position is in absolute screen coordinates. This typically applies to editor plugins. If the setting is ``true``, the window's position is in the coordinates of its parent :ref:`Viewport<class_Viewport>`.
  772. \ **Note:** This property only works if :ref:`initial_position<class_Window_property_initial_position>` is set to :ref:`WINDOW_INITIAL_POSITION_ABSOLUTE<class_Window_constant_WINDOW_INITIAL_POSITION_ABSOLUTE>`.
  773. .. rst-class:: classref-item-separator
  774. ----
  775. .. _class_Window_property_size:
  776. .. rst-class:: classref-property
  777. :ref:`Vector2i<class_Vector2i>` **size** = ``Vector2i(100, 100)``
  778. .. rst-class:: classref-property-setget
  779. - void **set_size** **(** :ref:`Vector2i<class_Vector2i>` value **)**
  780. - :ref:`Vector2i<class_Vector2i>` **get_size** **(** **)**
  781. The window's size in pixels.
  782. .. rst-class:: classref-item-separator
  783. ----
  784. .. _class_Window_property_theme:
  785. .. rst-class:: classref-property
  786. :ref:`Theme<class_Theme>` **theme**
  787. .. rst-class:: classref-property-setget
  788. - void **set_theme** **(** :ref:`Theme<class_Theme>` value **)**
  789. - :ref:`Theme<class_Theme>` **get_theme** **(** **)**
  790. 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.
  791. \ **Note:** **Window** styles will have no effect unless the window is embedded.
  792. .. rst-class:: classref-item-separator
  793. ----
  794. .. _class_Window_property_theme_type_variation:
  795. .. rst-class:: classref-property
  796. :ref:`StringName<class_StringName>` **theme_type_variation** = ``&""``
  797. .. rst-class:: classref-property-setget
  798. - void **set_theme_type_variation** **(** :ref:`StringName<class_StringName>` value **)**
  799. - :ref:`StringName<class_StringName>` **get_theme_type_variation** **(** **)**
  800. 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.
  801. .. rst-class:: classref-item-separator
  802. ----
  803. .. _class_Window_property_title:
  804. .. rst-class:: classref-property
  805. :ref:`String<class_String>` **title** = ``""``
  806. .. rst-class:: classref-property-setget
  807. - void **set_title** **(** :ref:`String<class_String>` value **)**
  808. - :ref:`String<class_String>` **get_title** **(** **)**
  809. The window's title. If the **Window** is native, title styles set in :ref:`Theme<class_Theme>` will have no effect.
  810. .. rst-class:: classref-item-separator
  811. ----
  812. .. _class_Window_property_transient:
  813. .. rst-class:: classref-property
  814. :ref:`bool<class_bool>` **transient** = ``false``
  815. .. rst-class:: classref-property-setget
  816. - void **set_transient** **(** :ref:`bool<class_bool>` value **)**
  817. - :ref:`bool<class_bool>` **is_transient** **(** **)**
  818. If ``true``, the **Window** is transient, i.e. it's considered a child of another **Window**. The transient window 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.
  819. Note that behavior might be different depending on the platform.
  820. .. rst-class:: classref-item-separator
  821. ----
  822. .. _class_Window_property_transparent:
  823. .. rst-class:: classref-property
  824. :ref:`bool<class_bool>` **transparent** = ``false``
  825. .. rst-class:: classref-property-setget
  826. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  827. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  828. If ``true``, the **Window**'s background can be transparent. This is best used with embedded windows.
  829. \ **Note:** Transparency support is implemented on Linux, macOS and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
  830. \ **Note:** This property has no effect if either :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>`, or the window's :ref:`Viewport.transparent_bg<class_Viewport_property_transparent_bg>` is set to ``false``.
  831. .. rst-class:: classref-item-separator
  832. ----
  833. .. _class_Window_property_unfocusable:
  834. .. rst-class:: classref-property
  835. :ref:`bool<class_bool>` **unfocusable** = ``false``
  836. .. rst-class:: classref-property-setget
  837. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  838. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  839. If ``true``, the **Window** can't be focused nor interacted with. It can still be visible.
  840. .. rst-class:: classref-item-separator
  841. ----
  842. .. _class_Window_property_unresizable:
  843. .. rst-class:: classref-property
  844. :ref:`bool<class_bool>` **unresizable** = ``false``
  845. .. rst-class:: classref-property-setget
  846. - void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  847. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  848. If ``true``, the window can't be resized. Minimize and maximize buttons are disabled.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. _class_Window_property_visible:
  852. .. rst-class:: classref-property
  853. :ref:`bool<class_bool>` **visible** = ``true``
  854. .. rst-class:: classref-property-setget
  855. - void **set_visible** **(** :ref:`bool<class_bool>` value **)**
  856. - :ref:`bool<class_bool>` **is_visible** **(** **)**
  857. If ``true``, the window is visible.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _class_Window_property_wrap_controls:
  861. .. rst-class:: classref-property
  862. :ref:`bool<class_bool>` **wrap_controls** = ``false``
  863. .. rst-class:: classref-property-setget
  864. - void **set_wrap_controls** **(** :ref:`bool<class_bool>` value **)**
  865. - :ref:`bool<class_bool>` **is_wrapping_controls** **(** **)**
  866. 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.
  867. If ``false``, you need to call :ref:`child_controls_changed<class_Window_method_child_controls_changed>` manually.
  868. .. rst-class:: classref-section-separator
  869. ----
  870. .. rst-class:: classref-descriptions-group
  871. Method Descriptions
  872. -------------------
  873. .. _class_Window_private_method__get_contents_minimum_size:
  874. .. rst-class:: classref-method
  875. :ref:`Vector2<class_Vector2>` **_get_contents_minimum_size** **(** **)** |virtual| |const|
  876. Virtual method to be implemented by the user. Overrides the value returned by :ref:`get_contents_minimum_size<class_Window_method_get_contents_minimum_size>`.
  877. .. rst-class:: classref-item-separator
  878. ----
  879. .. _class_Window_method_add_theme_color_override:
  880. .. rst-class:: classref-method
  881. void **add_theme_color_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Color<class_Color>` color **)**
  882. 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>`.
  883. 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.
  884. .. rst-class:: classref-item-separator
  885. ----
  886. .. _class_Window_method_add_theme_constant_override:
  887. .. rst-class:: classref-method
  888. void **add_theme_constant_override** **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` constant **)**
  889. 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>`.
  890. See also :ref:`get_theme_constant<class_Window_method_get_theme_constant>`.
  891. .. rst-class:: classref-item-separator
  892. ----
  893. .. _class_Window_method_add_theme_font_override:
  894. .. rst-class:: classref-method
  895. void **add_theme_font_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Font<class_Font>` font **)**
  896. 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>`.
  897. See also :ref:`get_theme_font<class_Window_method_get_theme_font>`.
  898. .. rst-class:: classref-item-separator
  899. ----
  900. .. _class_Window_method_add_theme_font_size_override:
  901. .. rst-class:: classref-method
  902. void **add_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` font_size **)**
  903. 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>`.
  904. See also :ref:`get_theme_font_size<class_Window_method_get_theme_font_size>`.
  905. .. rst-class:: classref-item-separator
  906. ----
  907. .. _class_Window_method_add_theme_icon_override:
  908. .. rst-class:: classref-method
  909. void **add_theme_icon_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Texture2D<class_Texture2D>` texture **)**
  910. 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>`.
  911. See also :ref:`get_theme_icon<class_Window_method_get_theme_icon>`.
  912. .. rst-class:: classref-item-separator
  913. ----
  914. .. _class_Window_method_add_theme_stylebox_override:
  915. .. rst-class:: classref-method
  916. void **add_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name, :ref:`StyleBox<class_StyleBox>` stylebox **)**
  917. 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>`.
  918. 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.
  919. .. rst-class:: classref-item-separator
  920. ----
  921. .. _class_Window_method_begin_bulk_theme_override:
  922. .. rst-class:: classref-method
  923. void **begin_bulk_theme_override** **(** **)**
  924. 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.
  925. .. rst-class:: classref-item-separator
  926. ----
  927. .. _class_Window_method_can_draw:
  928. .. rst-class:: classref-method
  929. :ref:`bool<class_bool>` **can_draw** **(** **)** |const|
  930. Returns whether the window is being drawn to the screen.
  931. .. rst-class:: classref-item-separator
  932. ----
  933. .. _class_Window_method_child_controls_changed:
  934. .. rst-class:: classref-method
  935. void **child_controls_changed** **(** **)**
  936. Requests an update of the **Window** size to fit underlying :ref:`Control<class_Control>` nodes.
  937. .. rst-class:: classref-item-separator
  938. ----
  939. .. _class_Window_method_end_bulk_theme_override:
  940. .. rst-class:: classref-method
  941. void **end_bulk_theme_override** **(** **)**
  942. Ends a bulk theme override update. See :ref:`begin_bulk_theme_override<class_Window_method_begin_bulk_theme_override>`.
  943. .. rst-class:: classref-item-separator
  944. ----
  945. .. _class_Window_method_get_contents_minimum_size:
  946. .. rst-class:: classref-method
  947. :ref:`Vector2<class_Vector2>` **get_contents_minimum_size** **(** **)** |const|
  948. 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.
  949. The value returned by this method can be overridden with :ref:`_get_contents_minimum_size<class_Window_private_method__get_contents_minimum_size>`.
  950. .. rst-class:: classref-item-separator
  951. ----
  952. .. _class_Window_method_get_flag:
  953. .. rst-class:: classref-method
  954. :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_Window_Flags>` flag **)** |const|
  955. Returns ``true`` if the ``flag`` is set.
  956. .. rst-class:: classref-item-separator
  957. ----
  958. .. _class_Window_method_get_layout_direction:
  959. .. rst-class:: classref-method
  960. :ref:`LayoutDirection<enum_Window_LayoutDirection>` **get_layout_direction** **(** **)** |const|
  961. Returns layout direction and text writing direction.
  962. .. rst-class:: classref-item-separator
  963. ----
  964. .. _class_Window_method_get_position_with_decorations:
  965. .. rst-class:: classref-method
  966. :ref:`Vector2i<class_Vector2i>` **get_position_with_decorations** **(** **)** |const|
  967. Returns the window's position including its border.
  968. .. rst-class:: classref-item-separator
  969. ----
  970. .. _class_Window_method_get_size_with_decorations:
  971. .. rst-class:: classref-method
  972. :ref:`Vector2i<class_Vector2i>` **get_size_with_decorations** **(** **)** |const|
  973. Returns the window's size including its border.
  974. .. rst-class:: classref-item-separator
  975. ----
  976. .. _class_Window_method_get_theme_color:
  977. .. rst-class:: classref-method
  978. :ref:`Color<class_Color>` **get_theme_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  979. 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``.
  980. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for more details.
  981. .. rst-class:: classref-item-separator
  982. ----
  983. .. _class_Window_method_get_theme_constant:
  984. .. rst-class:: classref-method
  985. :ref:`int<class_int>` **get_theme_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  986. 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``.
  987. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for more details.
  988. .. rst-class:: classref-item-separator
  989. ----
  990. .. _class_Window_method_get_theme_default_base_scale:
  991. .. rst-class:: classref-method
  992. :ref:`float<class_float>` **get_theme_default_base_scale** **(** **)** |const|
  993. 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.
  994. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  995. .. rst-class:: classref-item-separator
  996. ----
  997. .. _class_Window_method_get_theme_default_font:
  998. .. rst-class:: classref-method
  999. :ref:`Font<class_Font>` **get_theme_default_font** **(** **)** |const|
  1000. 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.
  1001. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1002. .. rst-class:: classref-item-separator
  1003. ----
  1004. .. _class_Window_method_get_theme_default_font_size:
  1005. .. rst-class:: classref-method
  1006. :ref:`int<class_int>` **get_theme_default_font_size** **(** **)** |const|
  1007. 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.
  1008. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1009. .. rst-class:: classref-item-separator
  1010. ----
  1011. .. _class_Window_method_get_theme_font:
  1012. .. rst-class:: classref-method
  1013. :ref:`Font<class_Font>` **get_theme_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1014. 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``.
  1015. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1016. .. rst-class:: classref-item-separator
  1017. ----
  1018. .. _class_Window_method_get_theme_font_size:
  1019. .. rst-class:: classref-method
  1020. :ref:`int<class_int>` **get_theme_font_size** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1021. 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``.
  1022. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _class_Window_method_get_theme_icon:
  1026. .. rst-class:: classref-method
  1027. :ref:`Texture2D<class_Texture2D>` **get_theme_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1028. 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``.
  1029. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1030. .. rst-class:: classref-item-separator
  1031. ----
  1032. .. _class_Window_method_get_theme_stylebox:
  1033. .. rst-class:: classref-method
  1034. :ref:`StyleBox<class_StyleBox>` **get_theme_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1035. 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``.
  1036. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1037. .. rst-class:: classref-item-separator
  1038. ----
  1039. .. _class_Window_method_get_window_id:
  1040. .. rst-class:: classref-method
  1041. :ref:`int<class_int>` **get_window_id** **(** **)** |const|
  1042. Returns the ID of the window.
  1043. .. rst-class:: classref-item-separator
  1044. ----
  1045. .. _class_Window_method_grab_focus:
  1046. .. rst-class:: classref-method
  1047. void **grab_focus** **(** **)**
  1048. Causes the window to grab focus, allowing it to receive user input.
  1049. .. rst-class:: classref-item-separator
  1050. ----
  1051. .. _class_Window_method_has_focus:
  1052. .. rst-class:: classref-method
  1053. :ref:`bool<class_bool>` **has_focus** **(** **)** |const|
  1054. Returns ``true`` if the window is focused.
  1055. .. rst-class:: classref-item-separator
  1056. ----
  1057. .. _class_Window_method_has_theme_color:
  1058. .. rst-class:: classref-method
  1059. :ref:`bool<class_bool>` **has_theme_color** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1060. 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``.
  1061. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1062. .. rst-class:: classref-item-separator
  1063. ----
  1064. .. _class_Window_method_has_theme_color_override:
  1065. .. rst-class:: classref-method
  1066. :ref:`bool<class_bool>` **has_theme_color_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1067. 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.
  1068. See :ref:`add_theme_color_override<class_Window_method_add_theme_color_override>`.
  1069. .. rst-class:: classref-item-separator
  1070. ----
  1071. .. _class_Window_method_has_theme_constant:
  1072. .. rst-class:: classref-method
  1073. :ref:`bool<class_bool>` **has_theme_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1074. 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``.
  1075. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1076. .. rst-class:: classref-item-separator
  1077. ----
  1078. .. _class_Window_method_has_theme_constant_override:
  1079. .. rst-class:: classref-method
  1080. :ref:`bool<class_bool>` **has_theme_constant_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1081. Returns ``true`` if there is a local override for a theme constant with the specified ``name`` in this :ref:`Control<class_Control>` node.
  1082. See :ref:`add_theme_constant_override<class_Window_method_add_theme_constant_override>`.
  1083. .. rst-class:: classref-item-separator
  1084. ----
  1085. .. _class_Window_method_has_theme_font:
  1086. .. rst-class:: classref-method
  1087. :ref:`bool<class_bool>` **has_theme_font** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1088. 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``.
  1089. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1090. .. rst-class:: classref-item-separator
  1091. ----
  1092. .. _class_Window_method_has_theme_font_override:
  1093. .. rst-class:: classref-method
  1094. :ref:`bool<class_bool>` **has_theme_font_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1095. 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.
  1096. See :ref:`add_theme_font_override<class_Window_method_add_theme_font_override>`.
  1097. .. rst-class:: classref-item-separator
  1098. ----
  1099. .. _class_Window_method_has_theme_font_size:
  1100. .. rst-class:: classref-method
  1101. :ref:`bool<class_bool>` **has_theme_font_size** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1102. 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``.
  1103. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1104. .. rst-class:: classref-item-separator
  1105. ----
  1106. .. _class_Window_method_has_theme_font_size_override:
  1107. .. rst-class:: classref-method
  1108. :ref:`bool<class_bool>` **has_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1109. Returns ``true`` if there is a local override for a theme font size with the specified ``name`` in this :ref:`Control<class_Control>` node.
  1110. See :ref:`add_theme_font_size_override<class_Window_method_add_theme_font_size_override>`.
  1111. .. rst-class:: classref-item-separator
  1112. ----
  1113. .. _class_Window_method_has_theme_icon:
  1114. .. rst-class:: classref-method
  1115. :ref:`bool<class_bool>` **has_theme_icon** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1116. 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``.
  1117. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_Window_method_has_theme_icon_override:
  1121. .. rst-class:: classref-method
  1122. :ref:`bool<class_bool>` **has_theme_icon_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1123. Returns ``true`` if there is a local override for a theme icon with the specified ``name`` in this :ref:`Control<class_Control>` node.
  1124. See :ref:`add_theme_icon_override<class_Window_method_add_theme_icon_override>`.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_Window_method_has_theme_stylebox:
  1128. .. rst-class:: classref-method
  1129. :ref:`bool<class_bool>` **has_theme_stylebox** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` theme_type="" **)** |const|
  1130. 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``.
  1131. See :ref:`Control.get_theme_color<class_Control_method_get_theme_color>` for details.
  1132. .. rst-class:: classref-item-separator
  1133. ----
  1134. .. _class_Window_method_has_theme_stylebox_override:
  1135. .. rst-class:: classref-method
  1136. :ref:`bool<class_bool>` **has_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name **)** |const|
  1137. 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.
  1138. See :ref:`add_theme_stylebox_override<class_Window_method_add_theme_stylebox_override>`.
  1139. .. rst-class:: classref-item-separator
  1140. ----
  1141. .. _class_Window_method_hide:
  1142. .. rst-class:: classref-method
  1143. void **hide** **(** **)**
  1144. 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>`.
  1145. .. rst-class:: classref-item-separator
  1146. ----
  1147. .. _class_Window_method_is_embedded:
  1148. .. rst-class:: classref-method
  1149. :ref:`bool<class_bool>` **is_embedded** **(** **)** |const|
  1150. Returns ``true`` if the window is currently embedded in another window.
  1151. .. rst-class:: classref-item-separator
  1152. ----
  1153. .. _class_Window_method_is_layout_rtl:
  1154. .. rst-class:: classref-method
  1155. :ref:`bool<class_bool>` **is_layout_rtl** **(** **)** |const|
  1156. Returns ``true`` if layout is right-to-left.
  1157. .. rst-class:: classref-item-separator
  1158. ----
  1159. .. _class_Window_method_is_maximize_allowed:
  1160. .. rst-class:: classref-method
  1161. :ref:`bool<class_bool>` **is_maximize_allowed** **(** **)** |const|
  1162. Returns ``true`` if the window can be maximized (the maximize button is enabled).
  1163. .. rst-class:: classref-item-separator
  1164. ----
  1165. .. _class_Window_method_is_using_font_oversampling:
  1166. .. rst-class:: classref-method
  1167. :ref:`bool<class_bool>` **is_using_font_oversampling** **(** **)** |const|
  1168. Returns ``true`` if font oversampling is enabled. See :ref:`set_use_font_oversampling<class_Window_method_set_use_font_oversampling>`.
  1169. .. rst-class:: classref-item-separator
  1170. ----
  1171. .. _class_Window_method_move_to_center:
  1172. .. rst-class:: classref-method
  1173. void **move_to_center** **(** **)**
  1174. Centers a native window on the current screen and an embedded window on its embedder :ref:`Viewport<class_Viewport>`.
  1175. .. rst-class:: classref-item-separator
  1176. ----
  1177. .. _class_Window_method_move_to_foreground:
  1178. .. rst-class:: classref-method
  1179. void **move_to_foreground** **(** **)**
  1180. Moves the **Window** on top of other windows and focuses it.
  1181. .. rst-class:: classref-item-separator
  1182. ----
  1183. .. _class_Window_method_popup:
  1184. .. rst-class:: classref-method
  1185. void **popup** **(** :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**
  1186. 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.
  1187. .. rst-class:: classref-item-separator
  1188. ----
  1189. .. _class_Window_method_popup_centered:
  1190. .. rst-class:: classref-method
  1191. void **popup_centered** **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**
  1192. 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.
  1193. \ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size<class_Window_property_size>`.
  1194. .. rst-class:: classref-item-separator
  1195. ----
  1196. .. _class_Window_method_popup_centered_clamped:
  1197. .. rst-class:: classref-method
  1198. void **popup_centered_clamped** **(** :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**
  1199. Popups the **Window** centered inside its parent **Window**. ``fallback_ratio`` determines the maximum size of the **Window**, in relation to its parent.
  1200. \ **Note:** Calling it with the default value of ``minsize`` is equivalent to calling it with :ref:`size<class_Window_property_size>`.
  1201. .. rst-class:: classref-item-separator
  1202. ----
  1203. .. _class_Window_method_popup_centered_ratio:
  1204. .. rst-class:: classref-method
  1205. void **popup_centered_ratio** **(** :ref:`float<class_float>` ratio=0.8 **)**
  1206. If **Window** is embedded, popups the **Window** centered inside its embedder and sets its size as a ``ratio`` of embedder's size.
  1207. If **Window** is a native window, popups the **Window** centered inside the screen of its parent **Window** and sets its size as a ``ratio`` of the screen size.
  1208. .. rst-class:: classref-item-separator
  1209. ----
  1210. .. _class_Window_method_popup_exclusive:
  1211. .. rst-class:: classref-method
  1212. void **popup_exclusive** **(** :ref:`Node<class_Node>` from_node, :ref:`Rect2i<class_Rect2i>` rect=Rect2i(0, 0, 0, 0) **)**
  1213. Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup<class_Window_method_popup>` on it. The dialog must have no current parent, otherwise the method fails.
  1214. See also :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` and :ref:`Node.get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`.
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_Window_method_popup_exclusive_centered:
  1218. .. rst-class:: classref-method
  1219. void **popup_exclusive_centered** **(** :ref:`Node<class_Node>` from_node, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0) **)**
  1220. Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered<class_Window_method_popup_centered>` on it. The dialog must have no current parent, otherwise the method fails.
  1221. See also :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` and :ref:`Node.get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`.
  1222. .. rst-class:: classref-item-separator
  1223. ----
  1224. .. _class_Window_method_popup_exclusive_centered_clamped:
  1225. .. rst-class:: classref-method
  1226. void **popup_exclusive_centered_clamped** **(** :ref:`Node<class_Node>` from_node, :ref:`Vector2i<class_Vector2i>` minsize=Vector2i(0, 0), :ref:`float<class_float>` fallback_ratio=0.75 **)**
  1227. Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered_clamped<class_Window_method_popup_centered_clamped>` on it. The dialog must have no current parent, otherwise the method fails.
  1228. See also :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` and :ref:`Node.get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`.
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_Window_method_popup_exclusive_centered_ratio:
  1232. .. rst-class:: classref-method
  1233. void **popup_exclusive_centered_ratio** **(** :ref:`Node<class_Node>` from_node, :ref:`float<class_float>` ratio=0.8 **)**
  1234. Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_centered_ratio<class_Window_method_popup_centered_ratio>` on it. The dialog must have no current parent, otherwise the method fails.
  1235. See also :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` and :ref:`Node.get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`.
  1236. .. rst-class:: classref-item-separator
  1237. ----
  1238. .. _class_Window_method_popup_exclusive_on_parent:
  1239. .. rst-class:: classref-method
  1240. void **popup_exclusive_on_parent** **(** :ref:`Node<class_Node>` from_node, :ref:`Rect2i<class_Rect2i>` parent_rect **)**
  1241. Attempts to parent this dialog to the last exclusive window relative to ``from_node``, and then calls :ref:`popup_on_parent<class_Window_method_popup_on_parent>` on it. The dialog must have no current parent, otherwise the method fails.
  1242. See also :ref:`set_unparent_when_invisible<class_Window_method_set_unparent_when_invisible>` and :ref:`Node.get_last_exclusive_window<class_Node_method_get_last_exclusive_window>`.
  1243. .. rst-class:: classref-item-separator
  1244. ----
  1245. .. _class_Window_method_popup_on_parent:
  1246. .. rst-class:: classref-method
  1247. void **popup_on_parent** **(** :ref:`Rect2i<class_Rect2i>` parent_rect **)**
  1248. 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>`.
  1249. .. rst-class:: classref-item-separator
  1250. ----
  1251. .. _class_Window_method_remove_theme_color_override:
  1252. .. rst-class:: classref-method
  1253. void **remove_theme_color_override** **(** :ref:`StringName<class_StringName>` name **)**
  1254. 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.
  1255. .. rst-class:: classref-item-separator
  1256. ----
  1257. .. _class_Window_method_remove_theme_constant_override:
  1258. .. rst-class:: classref-method
  1259. void **remove_theme_constant_override** **(** :ref:`StringName<class_StringName>` name **)**
  1260. 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.
  1261. .. rst-class:: classref-item-separator
  1262. ----
  1263. .. _class_Window_method_remove_theme_font_override:
  1264. .. rst-class:: classref-method
  1265. void **remove_theme_font_override** **(** :ref:`StringName<class_StringName>` name **)**
  1266. 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.
  1267. .. rst-class:: classref-item-separator
  1268. ----
  1269. .. _class_Window_method_remove_theme_font_size_override:
  1270. .. rst-class:: classref-method
  1271. void **remove_theme_font_size_override** **(** :ref:`StringName<class_StringName>` name **)**
  1272. 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.
  1273. .. rst-class:: classref-item-separator
  1274. ----
  1275. .. _class_Window_method_remove_theme_icon_override:
  1276. .. rst-class:: classref-method
  1277. void **remove_theme_icon_override** **(** :ref:`StringName<class_StringName>` name **)**
  1278. 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.
  1279. .. rst-class:: classref-item-separator
  1280. ----
  1281. .. _class_Window_method_remove_theme_stylebox_override:
  1282. .. rst-class:: classref-method
  1283. void **remove_theme_stylebox_override** **(** :ref:`StringName<class_StringName>` name **)**
  1284. 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.
  1285. .. rst-class:: classref-item-separator
  1286. ----
  1287. .. _class_Window_method_request_attention:
  1288. .. rst-class:: classref-method
  1289. void **request_attention** **(** **)**
  1290. 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.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_Window_method_reset_size:
  1294. .. rst-class:: classref-method
  1295. void **reset_size** **(** **)**
  1296. 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).
  1297. .. rst-class:: classref-item-separator
  1298. ----
  1299. .. _class_Window_method_set_flag:
  1300. .. rst-class:: classref-method
  1301. void **set_flag** **(** :ref:`Flags<enum_Window_Flags>` flag, :ref:`bool<class_bool>` enabled **)**
  1302. Sets a specified window flag.
  1303. .. rst-class:: classref-item-separator
  1304. ----
  1305. .. _class_Window_method_set_ime_active:
  1306. .. rst-class:: classref-method
  1307. void **set_ime_active** **(** :ref:`bool<class_bool>` active **)**
  1308. If ``active`` is ``true``, enables system's native IME (Input Method Editor).
  1309. .. rst-class:: classref-item-separator
  1310. ----
  1311. .. _class_Window_method_set_ime_position:
  1312. .. rst-class:: classref-method
  1313. void **set_ime_position** **(** :ref:`Vector2i<class_Vector2i>` position **)**
  1314. Moves IME to the given position.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _class_Window_method_set_layout_direction:
  1318. .. rst-class:: classref-method
  1319. void **set_layout_direction** **(** :ref:`LayoutDirection<enum_Window_LayoutDirection>` direction **)**
  1320. Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew).
  1321. .. rst-class:: classref-item-separator
  1322. ----
  1323. .. _class_Window_method_set_unparent_when_invisible:
  1324. .. rst-class:: classref-method
  1325. void **set_unparent_when_invisible** **(** :ref:`bool<class_bool>` unparent **)**
  1326. If ``unparent`` is ``true``, the window is automatically unparented when going invisible.
  1327. \ **Note:** Make sure to keep a reference to the node, otherwise it will be orphaned. You also need to manually call :ref:`Node.queue_free<class_Node_method_queue_free>` to free the window if it's not parented.
  1328. .. rst-class:: classref-item-separator
  1329. ----
  1330. .. _class_Window_method_set_use_font_oversampling:
  1331. .. rst-class:: classref-method
  1332. void **set_use_font_oversampling** **(** :ref:`bool<class_bool>` enable **)**
  1333. Enables font oversampling. This makes fonts look better when they are scaled up.
  1334. .. rst-class:: classref-item-separator
  1335. ----
  1336. .. _class_Window_method_show:
  1337. .. rst-class:: classref-method
  1338. void **show** **(** **)**
  1339. 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>`).
  1340. .. rst-class:: classref-section-separator
  1341. ----
  1342. .. rst-class:: classref-descriptions-group
  1343. Theme Property Descriptions
  1344. ---------------------------
  1345. .. _class_Window_theme_color_title_color:
  1346. .. rst-class:: classref-themeproperty
  1347. :ref:`Color<class_Color>` **title_color** = ``Color(0.875, 0.875, 0.875, 1)``
  1348. The color of the title's text.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_Window_theme_color_title_outline_modulate:
  1352. .. rst-class:: classref-themeproperty
  1353. :ref:`Color<class_Color>` **title_outline_modulate** = ``Color(1, 1, 1, 1)``
  1354. The color of the title's text outline.
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_Window_theme_constant_close_h_offset:
  1358. .. rst-class:: classref-themeproperty
  1359. :ref:`int<class_int>` **close_h_offset** = ``18``
  1360. Horizontal position offset of the close button.
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _class_Window_theme_constant_close_v_offset:
  1364. .. rst-class:: classref-themeproperty
  1365. :ref:`int<class_int>` **close_v_offset** = ``24``
  1366. Vertical position offset of the close button.
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _class_Window_theme_constant_resize_margin:
  1370. .. rst-class:: classref-themeproperty
  1371. :ref:`int<class_int>` **resize_margin** = ``4``
  1372. Defines the outside margin at which the window border can be grabbed with mouse and resized.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_Window_theme_constant_title_height:
  1376. .. rst-class:: classref-themeproperty
  1377. :ref:`int<class_int>` **title_height** = ``36``
  1378. Height of the title bar.
  1379. .. rst-class:: classref-item-separator
  1380. ----
  1381. .. _class_Window_theme_constant_title_outline_size:
  1382. .. rst-class:: classref-themeproperty
  1383. :ref:`int<class_int>` **title_outline_size** = ``0``
  1384. The size of the title outline.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_Window_theme_font_title_font:
  1388. .. rst-class:: classref-themeproperty
  1389. :ref:`Font<class_Font>` **title_font**
  1390. The font used to draw the title.
  1391. .. rst-class:: classref-item-separator
  1392. ----
  1393. .. _class_Window_theme_font_size_title_font_size:
  1394. .. rst-class:: classref-themeproperty
  1395. :ref:`int<class_int>` **title_font_size**
  1396. The size of the title font.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_Window_theme_icon_close:
  1400. .. rst-class:: classref-themeproperty
  1401. :ref:`Texture2D<class_Texture2D>` **close**
  1402. The icon for the close button.
  1403. .. rst-class:: classref-item-separator
  1404. ----
  1405. .. _class_Window_theme_icon_close_pressed:
  1406. .. rst-class:: classref-themeproperty
  1407. :ref:`Texture2D<class_Texture2D>` **close_pressed**
  1408. The icon for the close button when it's being pressed.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _class_Window_theme_style_embedded_border:
  1412. .. rst-class:: classref-themeproperty
  1413. :ref:`StyleBox<class_StyleBox>` **embedded_border**
  1414. 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>`.
  1415. \ **Note:** The content background will not be visible unless :ref:`transparent<class_Window_property_transparent>` is enabled.
  1416. .. rst-class:: classref-item-separator
  1417. ----
  1418. .. _class_Window_theme_style_embedded_unfocused_border:
  1419. .. rst-class:: classref-themeproperty
  1420. :ref:`StyleBox<class_StyleBox>` **embedded_unfocused_border**
  1421. The background style used when the **Window** is embedded and unfocused.
  1422. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1423. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1424. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1425. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1426. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1427. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1428. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`