diff options
Diffstat (limited to 'doc/classes/Control.xml')
| -rw-r--r-- | doc/classes/Control.xml | 366 |
1 files changed, 187 insertions, 179 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 9fc80e1aab..71798d2574 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -24,10 +24,10 @@ <methods> <method name="_can_drop_data" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="at_position" type="Vector2" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="at_position" type="Vector2" /> + <param index="1" name="data" type="Variant" /> <description> - Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. + Godot calls this method to test if [param data] from a control's [method _get_drag_data] can be dropped at [param at_position]. [param at_position] is local to this control. This method should only be used to test the data. Process the data in [method _drop_data]. [codeblocks] [gdscript] @@ -49,10 +49,10 @@ </method> <method name="_drop_data" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="at_position" type="Vector2" /> - <argument index="1" name="data" type="Variant" /> + <param index="0" name="at_position" type="Vector2" /> + <param index="1" name="data" type="Variant" /> <description> - Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. + Godot calls this method to pass you the [param data] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [param data] is allowed to drop at [param at_position] where [param at_position] is local to this control. [codeblocks] [gdscript] func _can_drop_data(position, data): @@ -75,9 +75,9 @@ </method> <method name="_get_drag_data" qualifiers="virtual const"> <return type="Variant" /> - <argument index="0" name="at_position" type="Vector2" /> + <param index="0" name="at_position" type="Vector2" /> <description> - Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [param at_position] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. [codeblocks] [gdscript] @@ -107,7 +107,7 @@ </method> <method name="_gui_input" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event]. Example: clicking a control. @@ -143,20 +143,20 @@ </method> <method name="_has_point" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> - Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. + Virtual method to be implemented by the user. Returns whether the given [param position] is inside this control. If not overridden, default behavior is checking if the point is within control's Rect. [b]Note:[/b] If you want to check if a point is inside the control, you can use [code]get_rect().has_point(point)[/code]. </description> </method> <method name="_make_custom_tooltip" qualifiers="virtual const"> <return type="Object" /> - <argument index="0" name="for_text" type="String" /> + <param index="0" name="for_text" type="String" /> <description> - Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property. + Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [param for_text] includes the contents of the [member tooltip_text] property. The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead. - The returned node will be added as child to a [PopupPanel], so you should only provide the contents of that panel. That [PopupPanel] can be themed using [method Theme.set_stylebox] for the type [code]"TooltipPanel"[/code] (see [member hint_tooltip] for an example). + The returned node will be added as child to a [PopupPanel], so you should only provide the contents of that panel. That [PopupPanel] can be themed using [method Theme.set_stylebox] for the type [code]"TooltipPanel"[/code] (see [member tooltip_text] for an example). [b]Note:[/b] The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its [member custom_minimum_size] to some non-zero value. [b]Note:[/b] The node (and any relevant children) should be [member CanvasItem.visible] when returned, otherwise, the viewport that instantiates it will not be able to calculate its minimum size reliably. Example of usage with a custom-constructed node: @@ -196,12 +196,12 @@ </description> </method> <method name="_structured_text_parser" qualifiers="virtual const"> - <return type="Array" /> - <argument index="0" name="args" type="Array" /> - <argument index="1" name="text" type="String" /> + <return type="Vector2i[]" /> + <param index="0" name="args" type="Array" /> + <param index="1" name="text" type="String" /> <description> User defined BiDi algorithm override function. - Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. + Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [param text] without overlaps. BiDi algorithm will be used on each range separately. </description> </method> <method name="accept_event"> @@ -212,10 +212,10 @@ </method> <method name="add_theme_color_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="color" type="Color" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="color" type="Color" /> <description> - Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override]. + Creates a local override for a theme [Color] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override]. See also [method get_theme_color]. [b]Example of overriding a label's color and resetting it later:[/b] [codeblocks] @@ -240,46 +240,46 @@ </method> <method name="add_theme_constant_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="constant" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="constant" type="int" /> <description> - Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override]. + Creates a local override for a theme constant with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override]. See also [method get_theme_constant]. </description> </method> <method name="add_theme_font_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="font" type="Font" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="font" type="Font" /> <description> - Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override]. + Creates a local override for a theme [Font] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override]. See also [method get_theme_font]. </description> </method> <method name="add_theme_font_size_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="font_size" type="int" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="font_size" type="int" /> <description> - Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override]. + Creates a local override for a theme font size with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override]. See also [method get_theme_font_size]. </description> </method> <method name="add_theme_icon_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="texture" type="Texture2D" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="texture" type="Texture2D" /> <description> - Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override]. + Creates a local override for a theme icon with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override]. See also [method get_theme_icon]. </description> </method> <method name="add_theme_stylebox_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="stylebox" type="StyleBox" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="stylebox" type="StyleBox" /> <description> - Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override]. + Creates a local override for a theme [StyleBox] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override]. See also [method get_theme_stylebox]. [b]Example of modifying a property in a StyleBox by duplicating it:[/b] [codeblocks] @@ -334,16 +334,16 @@ </method> <method name="force_drag"> <return type="void" /> - <argument index="0" name="data" type="Variant" /> - <argument index="1" name="preview" type="Control" /> + <param index="0" name="data" type="Variant" /> + <param index="1" name="preview" type="Control" /> <description> - Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. + Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [param data] and [param preview]. Drag will start even if the mouse is neither over nor pressed on this control. The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data. </description> </method> <method name="get_anchor" qualifiers="const"> <return type="float" /> - <argument index="0" name="side" type="int" enum="Side" /> + <param index="0" name="side" type="int" enum="Side" /> <description> Returns the anchor for the specified [enum Side]. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. </description> @@ -362,7 +362,7 @@ </method> <method name="get_cursor_shape" qualifiers="const"> <return type="int" enum="Control.CursorShape" /> - <argument index="0" name="position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="position" type="Vector2" default="Vector2(0, 0)" /> <description> Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. </description> @@ -375,7 +375,7 @@ </method> <method name="get_focus_neighbor" qualifiers="const"> <return type="NodePath" /> - <argument index="0" name="side" type="int" enum="Side" /> + <param index="0" name="side" type="int" enum="Side" /> <description> Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. </description> @@ -394,7 +394,7 @@ </method> <method name="get_offset" qualifiers="const"> <return type="float" /> - <argument index="0" name="offset" type="int" enum="Side" /> + <param index="0" name="offset" type="int" enum="Side" /> <description> Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. </description> @@ -432,11 +432,11 @@ </method> <method name="get_theme_color" qualifiers="const"> <return type="Color" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. - For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used. + Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [param name] and [param theme_type]. If [param theme_type] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. + For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, the custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used (see [ThemeDB]). [codeblocks] [gdscript] func _ready(): @@ -459,10 +459,10 @@ </method> <method name="get_theme_constant" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> @@ -489,45 +489,46 @@ </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="get_theme_font_size" qualifiers="const"> <return type="int" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="get_theme_icon" qualifiers="const"> <return type="Texture2D" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="get_theme_stylebox" qualifiers="const"> <return type="StyleBox" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="get_tooltip" qualifiers="const"> <return type="String" /> - <argument index="0" name="at_position" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="at_position" type="Vector2" default="Vector2(0, 0)" /> <description> - Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. + Returns the tooltip text [param at_position] in local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns [member tooltip_text]. + [b]Note:[/b] This method can be overriden to customise its behaviour. If this method returns an empty [String], no tooltip is displayed. </description> </method> <method name="grab_click_focus"> @@ -552,6 +553,7 @@ <return type="void" /> <description> Steal the focus from another control and become the focused control (see [member focus_mode]). + [b]Note[/b]: Using this method together with [method Callable.call_deferred] makes it more reliable, especially when called inside [method Node._ready]. </description> </method> <method name="has_focus" qualifiers="const"> @@ -562,103 +564,103 @@ </method> <method name="has_theme_color" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_color_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [param name] in this [Control] node. See [method add_theme_color_override]. </description> </method> <method name="has_theme_constant" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_constant_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme constant with the specified [param name] in this [Control] node. See [method add_theme_constant_override]. </description> </method> <method name="has_theme_font" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_font_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [param name] in this [Control] node. See [method add_theme_font_override]. </description> </method> <method name="has_theme_font_size" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_font_size_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme font size with the specified [param name] in this [Control] node. See [method add_theme_font_size_override]. </description> </method> <method name="has_theme_icon" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_icon_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme icon with the specified [param name] in this [Control] node. See [method add_theme_icon_override]. </description> </method> <method name="has_theme_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> - <argument index="1" name="theme_type" type="StringName" default="""" /> + <param index="0" name="name" type="StringName" /> + <param index="1" name="theme_type" type="StringName" default="""" /> <description> - Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. + Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [param name] and [param theme_type]. See [method get_theme_color] for details. </description> </method> <method name="has_theme_stylebox_override" qualifiers="const"> <return type="bool" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node. + Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [param name] in this [Control] node. See [method add_theme_stylebox_override]. </description> </method> @@ -683,44 +685,44 @@ </method> <method name="remove_theme_color_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock. + Removes a local override for a theme [Color] with the specified [param name] previously added by [method add_theme_color_override] or via the Inspector dock. </description> </method> <method name="remove_theme_constant_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock. + Removes a local override for a theme constant with the specified [param name] previously added by [method add_theme_constant_override] or via the Inspector dock. </description> </method> <method name="remove_theme_font_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock. + Removes a local override for a theme [Font] with the specified [param name] previously added by [method add_theme_font_override] or via the Inspector dock. </description> </method> <method name="remove_theme_font_size_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock. + Removes a local override for a theme font size with the specified [param name] previously added by [method add_theme_font_size_override] or via the Inspector dock. </description> </method> <method name="remove_theme_icon_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock. + Removes a local override for a theme icon with the specified [param name] previously added by [method add_theme_icon_override] or via the Inspector dock. </description> </method> <method name="remove_theme_stylebox_override"> <return type="void" /> - <argument index="0" name="name" type="StringName" /> + <param index="0" name="name" type="StringName" /> <description> - Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock. + Removes a local override for a theme [StyleBox] with the specified [param name] previously added by [method add_theme_stylebox_override] or via the Inspector dock. </description> </method> <method name="reset_size"> @@ -731,56 +733,56 @@ </method> <method name="set_anchor"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="anchor" type="float" /> - <argument index="2" name="keep_offset" type="bool" default="false" /> - <argument index="3" name="push_opposite_anchor" type="bool" default="true" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="anchor" type="float" /> + <param index="2" name="keep_offset" type="bool" default="false" /> + <param index="3" name="push_opposite_anchor" type="bool" default="true" /> <description> - Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. - If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation. - If [code]push_opposite_anchor[/code] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [code]push_opposite_anchor[/code] was [code]false[/code], the left anchor would get value 0.5. + Sets the anchor for the specified [enum Side] to [param anchor]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. + If [param keep_offset] is [code]true[/code], offsets aren't updated after this operation. + If [param push_opposite_anchor] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [param push_opposite_anchor] was [code]false[/code], the left anchor would get value 0.5. </description> </method> <method name="set_anchor_and_offset"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="anchor" type="float" /> - <argument index="2" name="offset" type="float" /> - <argument index="3" name="push_opposite_anchor" type="bool" default="false" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="anchor" type="float" /> + <param index="2" name="offset" type="float" /> + <param index="3" name="push_opposite_anchor" type="bool" default="false" /> <description> Works the same as [method set_anchor], but instead of [code]keep_offset[/code] argument and automatic update of offset, it allows to set the offset yourself (see [method set_offset]). </description> </method> <method name="set_anchors_and_offsets_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> - <argument index="2" name="margin" type="int" default="0" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> + <param index="2" name="margin" type="int" default="0" /> <description> Sets both anchor preset and offset preset. See [method set_anchors_preset] and [method set_offsets_preset]. </description> </method> <method name="set_anchors_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> - Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. - If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated. + Sets the anchors to a [param preset] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. + If [param keep_offsets] is [code]true[/code], control's position will also be updated. </description> </method> <method name="set_begin"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Sets [member offset_left] and [member offset_top] at the same time. Equivalent of changing [member position]. </description> </method> <method name="set_drag_forwarding"> <return type="void" /> - <argument index="0" name="target" type="Object" /> + <param index="0" name="target" type="Object" /> <description> - Forwards the handling of this control's drag and drop to [code]target[/code] object. + Forwards the handling of this control's drag and drop to [param target] object. Forwarding can be implemented in the target object similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: 1. The function name must be suffixed with [b]_fw[/b] 2. The function must take an extra argument that is the control doing the forwarding @@ -843,7 +845,7 @@ </method> <method name="set_drag_preview"> <return type="void" /> - <argument index="0" name="control" type="Control" /> + <param index="0" name="control" type="Control" /> <description> Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. [codeblocks] @@ -877,63 +879,63 @@ </method> <method name="set_end"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> Sets [member offset_right] and [member offset_bottom] at the same time. </description> </method> <method name="set_focus_neighbor"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="neighbor" type="NodePath" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="neighbor" type="NodePath" /> <description> - Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. + Sets the anchor for the specified [enum Side] to the [Control] at [param neighbor] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. </description> </method> <method name="set_global_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> - Sets the [member global_position] to given [code]position[/code]. - If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. + Sets the [member global_position] to given [param position]. + If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets. </description> </method> <method name="set_offset"> <return type="void" /> - <argument index="0" name="side" type="int" enum="Side" /> - <argument index="1" name="offset" type="float" /> + <param index="0" name="side" type="int" enum="Side" /> + <param index="1" name="offset" type="float" /> <description> - Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. + Sets the offset for the specified [enum Side] to [param offset]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. </description> </method> <method name="set_offsets_preset"> <return type="void" /> - <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" /> - <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> - <argument index="2" name="margin" type="int" default="0" /> + <param index="0" name="preset" type="int" enum="Control.LayoutPreset" /> + <param index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" /> + <param index="2" name="margin" type="int" default="0" /> <description> - Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. - Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. - Use parameter [code]margin[/code] to determine the gap between the [Control] and the edges. + Sets the offsets to a [param preset] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. + Use parameter [param resize_mode] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. + Use parameter [param margin] to determine the gap between the [Control] and the edges. </description> </method> <method name="set_position"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="position" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> - Sets the [member position] to given [code]position[/code]. - If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. + Sets the [member position] to given [param position]. + If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets. </description> </method> <method name="set_size"> <return type="void" /> - <argument index="0" name="size" type="Vector2" /> - <argument index="1" name="keep_offsets" type="bool" default="false" /> + <param index="0" name="size" type="Vector2" /> + <param index="1" name="keep_offsets" type="bool" default="false" /> <description> Sets the size (see [member size]). - If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. + If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets. </description> </method> <method name="update_minimum_size"> @@ -944,9 +946,9 @@ </method> <method name="warp_mouse"> <return type="void" /> - <argument index="0" name="position" type="Vector2" /> + <param index="0" name="position" type="Vector2" /> <description> - Moves the mouse cursor to [code]position[/code], relative to [member position] of this [Control]. + Moves the mouse cursor to [param position], relative to [member position] of this [Control]. </description> </method> </methods> @@ -1005,28 +1007,6 @@ <member name="grow_vertical" type="int" setter="set_v_grow_direction" getter="get_v_grow_direction" enum="Control.GrowDirection" default="1"> Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size. </member> - <member name="hint_tooltip" type="String" setter="set_tooltip" getter="_get_tooltip" default=""""> - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. You can change the time required for the tooltip to appear with [code]gui/timers/tooltip_delay_sec[/code] option in Project Settings. - The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding [method _make_custom_tooltip]. The default tooltip includes a [PopupPanel] and [Label] whose theme properties can be customized using [Theme] methods with the [code]"TooltipPanel"[/code] and [code]"TooltipLabel"[/code] respectively. For example: - [codeblocks] - [gdscript] - var style_box = StyleBoxFlat.new() - style_box.set_bg_color(Color(1, 1, 0)) - style_box.set_border_width_all(2) - # We assume here that the `theme` property has been assigned a custom Theme beforehand. - theme.set_stylebox("panel", "TooltipPanel", style_box) - theme.set_color("font_color", "TooltipLabel", Color(0, 1, 1)) - [/gdscript] - [csharp] - var styleBox = new StyleBoxFlat(); - styleBox.SetBgColor(new Color(1, 1, 0)); - styleBox.SetBorderWidthAll(2); - // We assume here that the `Theme` property has been assigned a custom Theme beforehand. - Theme.SetStyleBox("panel", "TooltipPanel", styleBox); - Theme.SetColor("font_color", "TooltipLabel", new Color(0, 1, 1)); - [/csharp] - [/codeblocks] - </member> <member name="layout_direction" type="int" setter="set_layout_direction" getter="get_layout_direction" enum="Control.LayoutDirection" default="0"> Controls layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew). </member> @@ -1067,7 +1047,7 @@ The node's rotation around its pivot, in radians. See [member pivot_offset] to change the pivot's position. </member> <member name="scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2(1, 1)"> - The node's scale, relative to its [member size]. Change this property to scale the node around its [member pivot_offset]. The Control's [member hint_tooltip] will also scale according to this value. + The node's scale, relative to its [member size]. Change this property to scale the node around its [member pivot_offset]. The Control's [member tooltip_text] will also scale according to this value. [b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=$DOCS_URL/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually. [b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using [code]await get_tree().process_frame[/code] then set its [member scale] property. </member> @@ -1092,6 +1072,28 @@ [b]Note:[/b] To look up [Control]'s own items use various [code]get_theme_*[/code] methods without specifying [code]theme_type[/code]. [b]Note:[/b] Theme items are looked for in the tree order, from branch to root, where each [Control] node is checked for its [member theme] property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last. </member> + <member name="tooltip_text" type="String" setter="set_tooltip_text" getter="get_tooltip_text" default=""""> + The default tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. The time required for the tooltip to appear can be changed with the [code]gui/timers/tooltip_delay_sec[/code] option in Project Settings. See also [method get_tooltip]. + The tooltip popup will use either a default implementation, or a custom one that you can provide by overriding [method _make_custom_tooltip]. The default tooltip includes a [PopupPanel] and [Label] whose theme properties can be customized using [Theme] methods with the [code]"TooltipPanel"[/code] and [code]"TooltipLabel"[/code] respectively. For example: + [codeblocks] + [gdscript] + var style_box = StyleBoxFlat.new() + style_box.set_bg_color(Color(1, 1, 0)) + style_box.set_border_width_all(2) + # We assume here that the `theme` property has been assigned a custom Theme beforehand. + theme.set_stylebox("panel", "TooltipPanel", style_box) + theme.set_color("font_color", "TooltipLabel", Color(0, 1, 1)) + [/gdscript] + [csharp] + var styleBox = new StyleBoxFlat(); + styleBox.SetBgColor(new Color(1, 1, 0)); + styleBox.SetBorderWidthAll(2); + // We assume here that the `Theme` property has been assigned a custom Theme beforehand. + Theme.SetStyleBox("panel", "TooltipPanel", styleBox); + Theme.SetColor("font_color", "TooltipLabel", new Color(0, 1, 1)); + [/csharp] + [/codeblocks] + </member> </members> <signals> <signal name="focus_entered"> @@ -1105,7 +1107,7 @@ </description> </signal> <signal name="gui_input"> - <argument index="0" name="event" type="InputEvent" /> + <param index="0" name="event" type="InputEvent" /> <description> Emitted when the node receives an [InputEvent]. </description> @@ -1145,6 +1147,7 @@ </signal> <signal name="theme_changed"> <description> + Emitted when the [constant NOTIFICATION_THEME_CHANGED] notification is sent. </description> </signal> </signals> @@ -1174,7 +1177,12 @@ Sent when the node loses focus. </constant> <constant name="NOTIFICATION_THEME_CHANGED" value="45"> - Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_theme_*_override[/code] methods. + Sent when the node needs to refresh its theme items. This happens in one of the following cases: + - The [member theme] property is changed on this node or any of its ancestors. + - The [member theme_type_variation] property is changed on this node. + - One of the node's theme property overrides is changed. + - The node enters the scene tree. + [b]Note:[/b] 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. </constant> <constant name="NOTIFICATION_SCROLL_BEGIN" value="47"> Sent when this node is inside a [ScrollContainer] which has begun being scrolled. |