godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Window.xml

477 lines
18 KiB
XML
Raw Normal View History

doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Window" inherits="Viewport" version="4.0">
<brief_description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Base class for all windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</brief_description>
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
A node that creates a window.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="can_draw" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Returns whether the window is being drawn to the screen.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="child_controls_changed">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Expose `Window.get_contents_minimum_size()` to scripts
2021-07-02 18:35:56 +00:00
<method name="get_contents_minimum_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Expose `Window.get_contents_minimum_size()` to scripts
2021-07-02 18:35:56 +00:00
<description>
Returns the combined minimum size from the child [Control] nodes of the window.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="get_flag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="Window.Flags" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Returns [code]true[/code] if the flag is set.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="get_layout_direction" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="Window.LayoutDirection" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns layout direction and text writing direction.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="get_real_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Returns the window's size including its border.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="get_theme_color" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Color" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="get_theme_constant" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
<method name="get_theme_default_base_scale" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_theme_default_font" qualifiers="const">
<return type="Font" />
<description>
</description>
</method>
<method name="get_theme_default_font_size" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="get_theme_font" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Font" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
Returns the [Font] at [code]name[/code] if the theme has [code]theme_type[/code].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="get_theme_font_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
Returns the font size at [code]name[/code] if the theme has [code]theme_type[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="get_theme_icon" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="get_theme_stylebox" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="StyleBox" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="grab_focus">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Causes the window to grab focus, allowing it to receive user input.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="has_focus" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Returns [code]true[/code] if the window is focused.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="has_theme_color" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="has_theme_constant" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="has_theme_font" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]theme_type[/code].
Returns [code]false[/code] if the theme does not have [code]theme_type[/code].
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="has_theme_font_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
Returns [code]true[/code] if font size with [code]name[/code] is in [code]theme_type[/code].
Returns [code]false[/code] if the theme does not have [code]theme_type[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="has_theme_icon" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="has_theme_stylebox" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="hide">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="is_embedded" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Returns [code]true[/code] if the window is currently embedded in another window.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="is_layout_rtl" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Returns [code]true[/code] if layout is right-to-left.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="is_maximize_allowed" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="is_using_font_oversampling" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="move_to_foreground">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="popup">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="popup_centered">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="popup_centered_clamped">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" />
<argument index="1" name="fallback_ratio" type="float" default="0.75" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="popup_centered_ratio">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="ratio" type="float" default="0.8" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="popup_on_parent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="parent_rect" type="Rect2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="request_attention">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Added `reset_size` method to `Control` and `Window` classes
2021-11-20 08:04:57 +00:00
<method name="reset_size">
<return type="void" />
<description>
Resets the size to the minimum size, which is the max of [member min_size] and (if [member wrap_controls] is enabled) [method get_contents_minimum_size]. This is equivalent to calling [code]set_size(Vector2i())[/code] (or any size below the minimum).
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="set_flag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="Window.Flags" />
<argument index="1" name="enabled" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Sets a specified window flag.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="set_ime_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="active" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="set_ime_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="position" type="Vector2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="set_layout_direction">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="direction" type="int" enum="Window.LayoutDirection" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew).
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="set_use_font_oversampling">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="show">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
</methods>
<members>
<member name="always_on_top" type="bool" setter="set_flag" getter="get_flag" default="false">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
If [code]true[/code], the window will be on top of all other windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
Add `auto_translate` toggle for automatic translation
2021-05-27 17:31:33 +00:00
<member name="auto_translate" type="bool" setter="set_auto_translate" getter="is_auto_translating" default="true">
Toggles if any text should automatically change to its translated version depending on the current locale.
</member>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<member name="borderless" type="bool" setter="set_flag" getter="get_flag" default="false">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
If [code]true[/code], the window will have no borders.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="content_scale_aspect" type="int" setter="set_content_scale_aspect" getter="get_content_scale_aspect" enum="Window.ContentScaleAspect" default="0">
</member>
add 2d scale factor property
2021-12-17 12:11:19 +00:00
<member name="content_scale_factor" type="float" setter="set_content_scale_factor" getter="get_content_scale_factor" default="1.0">
</member>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<member name="content_scale_mode" type="int" setter="set_content_scale_mode" getter="get_content_scale_mode" enum="Window.ContentScaleMode" default="0">
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="content_scale_size" type="Vector2i" setter="set_content_scale_size" getter="get_content_scale_size" default="Vector2i(0, 0)">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="current_screen" type="int" setter="set_current_screen" getter="get_current_screen" default="0">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
The screen the window is currently on.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="exclusive" type="bool" setter="set_exclusive" getter="is_exclusive" default="false">
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="max_size" type="Vector2i" setter="set_max_size" getter="get_max_size" default="Vector2i(0, 0)">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="min_size" type="Vector2i" setter="set_min_size" getter="get_min_size" default="Vector2i(0, 0)">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Window.Mode" default="0">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Set's the window's current mode.
[b]Note:[/b] Fullscreen mode is not exclusive fullscreen on Windows and Linux.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="position" type="Vector2i" setter="set_position" getter="get_position" default="Vector2i(0, 0)">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
The window's position in pixels.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="size" type="Vector2i" setter="set_size" getter="get_size" default="Vector2i(100, 100)">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
The window's size in pixels.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="theme" type="Theme" setter="set_theme" getter="get_theme">
</member>
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<member name="theme_type_variation" type="StringName" setter="set_theme_type_variation" getter="get_theme_type_variation" default="&amp;&quot;&quot;">
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
</member>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
The window's title.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="transient" type="bool" setter="set_transient" getter="is_transient" default="false">
</member>
<member name="transparent" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="unfocusable" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="unresizable" type="bool" setter="set_flag" getter="get_flag" default="false">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
If [code]true[/code], the window can't be resized.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
If [code]true[/code], the window is visible.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</member>
<member name="wrap_controls" type="bool" setter="set_wrap_controls" getter="is_wrapping_controls" default="false">
</member>
</members>
<signals>
<signal name="about_to_popup">
<description>
</description>
</signal>
<signal name="close_requested">
<description>
</description>
</signal>
<signal name="files_dropped">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<argument index="0" name="files" type="PackedStringArray" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</signal>
<signal name="focus_entered">
<description>
</description>
</signal>
<signal name="focus_exited">
<description>
</description>
</signal>
<signal name="go_back_requested">
<description>
</description>
</signal>
<signal name="mouse_entered">
<description>
</description>
</signal>
<signal name="mouse_exited">
<description>
</description>
</signal>
Add missing 'theme_changed' signal to Window class
2022-01-19 07:59:42 +00:00
<signal name="theme_changed">
<description>
</description>
</signal>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<signal name="visibility_changed">
<description>
</description>
</signal>
<signal name="window_input">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<argument index="0" name="event" type="InputEvent" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="30">
</constant>
<constant name="MODE_WINDOWED" value="0" enum="Mode">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Windowed mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MODE_MINIMIZED" value="1" enum="Mode">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Minimized window mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MODE_MAXIMIZED" value="2" enum="Mode">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Maximized window mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MODE_FULLSCREEN" value="3" enum="Mode">
Improve the documentation related to fullscreen and borderless settings
2020-09-03 19:59:40 +00:00
Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project.
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="FLAG_RESIZE_DISABLED" value="0" enum="Flags">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
The window's ability to be resized.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="FLAG_BORDERLESS" value="1" enum="Flags">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Borderless window.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="FLAG_ALWAYS_ON_TOP" value="2" enum="Flags">
Add many descriptions to the `Window` class This pull request adds many missing descriptions to `Window` in the class docs.
2021-07-05 13:43:51 +00:00
Flag for making the window always on top of all other windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="FLAG_TRANSPARENT" value="3" enum="Flags">
</constant>
<constant name="FLAG_NO_FOCUS" value="4" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="5" enum="Flags">
</constant>
<constant name="CONTENT_SCALE_MODE_DISABLED" value="0" enum="ContentScaleMode">
</constant>
doc: Sync classref with current source
2020-07-03 14:09:12 +00:00
<constant name="CONTENT_SCALE_MODE_CANVAS_ITEMS" value="1" enum="ContentScaleMode">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
doc: Sync classref with current source
2020-07-03 14:09:12 +00:00
<constant name="CONTENT_SCALE_MODE_VIEWPORT" value="2" enum="ContentScaleMode">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="CONTENT_SCALE_ASPECT_IGNORE" value="0" enum="ContentScaleAspect">
</constant>
<constant name="CONTENT_SCALE_ASPECT_KEEP" value="1" enum="ContentScaleAspect">
</constant>
<constant name="CONTENT_SCALE_ASPECT_KEEP_WIDTH" value="2" enum="ContentScaleAspect">
</constant>
<constant name="CONTENT_SCALE_ASPECT_KEEP_HEIGHT" value="3" enum="ContentScaleAspect">
</constant>
<constant name="CONTENT_SCALE_ASPECT_EXPAND" value="4" enum="ContentScaleAspect">
</constant>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<constant name="LAYOUT_DIRECTION_INHERITED" value="0" enum="LayoutDirection">
Automatic layout direction, determined from the parent control layout direction.
</constant>
<constant name="LAYOUT_DIRECTION_LOCALE" value="1" enum="LayoutDirection">
Automatic layout direction, determined from the current locale.
</constant>
<constant name="LAYOUT_DIRECTION_LTR" value="2" enum="LayoutDirection">
Left-to-right layout direction.
</constant>
<constant name="LAYOUT_DIRECTION_RTL" value="3" enum="LayoutDirection">
Right-to-left layout direction.
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constants>
<theme_items>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="title_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="title_outline_modulate" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
The color of the title outline.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="close_h_ofs" data_type="constant" type="int" default="18">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="close_v_ofs" data_type="constant" type="int" default="24">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="resize_margin" data_type="constant" type="int" default="4">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="scaleborder_size" data_type="constant" type="int" default="4">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="title_height" data_type="constant" type="int" default="36">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="title_outline_size" data_type="constant" type="int" default="0">
The size of the title outline.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="title_font" data_type="font" type="Font">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="title_font_size" data_type="font_size" type="int">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
The size of the title font.
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="close" data_type="icon" type="Texture2D">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="close_pressed" data_type="icon" type="Texture2D">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="embedded_border" data_type="style" type="StyleBox">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
</theme_item>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</theme_items>
</class>