class_window.rst 151 KB

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