class_window.rst 147 KB

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