godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2ac2db8de)

Browse Source
This commit is contained in:
Rémi Verschelde
2023-01-11 14:54:24 +01:00
parent fc52ca81f7
commit 33c61914b4
106 changed files with 1974 additions and 1151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
classes/class_control.rst
View File

@@ -129,11 +129,11 @@ Properties
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`size<class_Control_property_size>` | ``Vector2(0, 0)`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`int<class_int>` | :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` | ``1`` |
| :ref:`SizeFlags<enum_Control_SizeFlags>` | :ref:`size_flags_horizontal<class_Control_property_size_flags_horizontal>` | ``1`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`float<class_float>` | :ref:`size_flags_stretch_ratio<class_Control_property_size_flags_stretch_ratio>` | ``1.0`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`int<class_int>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` | ``1`` |
| :ref:`SizeFlags<enum_Control_SizeFlags>` | :ref:`size_flags_vertical<class_Control_property_size_flags_vertical>` | ``1`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`Theme<class_Theme>` | :ref:`theme<class_Control_property_theme>` | |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
@@ -297,7 +297,7 @@ Methods
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_begin<class_Control_method_set_begin>` **(** :ref:`Vector2<class_Vector2>` position **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_forwarding<class_Control_method_set_drag_forwarding>` **(** :ref:`Object<class_Object>` target **)** |
| void | :ref:`set_drag_forwarding<class_Control_method_set_drag_forwarding>` **(** :ref:`Callable<class_Callable>` drag_func, :ref:`Callable<class_Callable>` can_drop_func, :ref:`Callable<class_Callable>` drop_func **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_preview<class_Control_method_set_drag_preview>` **(** :ref:`Control<class_Control>` control **)** |
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -818,7 +818,7 @@ The control's size will not change.
.. rst-class:: classref-enumeration
enum **SizeFlags**:
flags **SizeFlags**:
.. _class_Control_constant_SIZE_SHRINK_BEGIN:
@@ -1730,12 +1730,12 @@ The size of the node's bounding rectangle, in pixels. :ref:`Container<class_Cont
.. rst-class:: classref-property
:ref:`int<class_int>` **size_flags_horizontal** = ``1``
:ref:`SizeFlags<enum_Control_SizeFlags>` **size_flags_horizontal** = ``1``
.. rst-class:: classref-property-setget
- void **set_h_size_flags** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_h_size_flags** **(** **)**
- void **set_h_size_flags** **(** :ref:`SizeFlags<enum_Control_SizeFlags>` value **)**
- :ref:`SizeFlags<enum_Control_SizeFlags>` **get_h_size_flags** **(** **)**
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the X axis. Use one of the :ref:`SizeFlags<enum_Control_SizeFlags>` constants to change the flags. See the constants to learn what each does.
@@ -1764,12 +1764,12 @@ If the node and at least one of its neighbors uses the :ref:`SIZE_EXPAND<class_C
.. rst-class:: classref-property
:ref:`int<class_int>` **size_flags_vertical** = ``1``
:ref:`SizeFlags<enum_Control_SizeFlags>` **size_flags_vertical** = ``1``
.. rst-class:: classref-property-setget
- void **set_v_size_flags** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_v_size_flags** **(** **)**
- void **set_v_size_flags** **(** :ref:`SizeFlags<enum_Control_SizeFlags>` value **)**
- :ref:`SizeFlags<enum_Control_SizeFlags>` **get_v_size_flags** **(** **)**
Tells the parent :ref:`Container<class_Container>` nodes how they should resize and place the node on the Y axis. Use one of the :ref:`SizeFlags<enum_Control_SizeFlags>` constants to change the flags. See the constants to learn what each does.
@@ -3095,75 +3095,13 @@ Sets :ref:`offset_left<class_Control_property_offset_left>` and :ref:`offset_top
.. rst-class:: classref-method
void **set_drag_forwarding** **(** :ref:`Object<class_Object>` target **)**
void **set_drag_forwarding** **(** :ref:`Callable<class_Callable>` drag_func, :ref:`Callable<class_Callable>` can_drop_func, :ref:`Callable<class_Callable>` drop_func **)**
Forwards the handling of this control's drag and drop to ``target`` object.
Forwarding can be implemented in the target object similar to the methods :ref:`_get_drag_data<class_Control_method__get_drag_data>`, :ref:`_can_drop_data<class_Control_method__can_drop_data>`, and :ref:`_drop_data<class_Control_method__drop_data>` but with two differences:
1. The function name must be suffixed with **_fw**\
2. The function must take an extra argument that is the control doing the forwarding
.. tabs::
.. code-tab:: gdscript
# ThisControl.gd
extends Control
export(Control) var target_control
func _ready():
set_drag_forwarding(target_control)
# TargetControl.gd
extends Control
func _can_drop_data_fw(position, data, from_control):
return true
func _drop_data_fw(position, data, from_control):
my_handle_data(data) # Your handler method.
func _get_drag_data_fw(position, from_control):
set_drag_preview(my_preview)
return my_data()
.. code-tab:: csharp
// ThisControl.cs
public class ThisControl : Control
{
[Export]
public Control TargetControl { get; set; }
public override void _Ready()
{
SetDragForwarding(TargetControl);
}
}
// TargetControl.cs
public class TargetControl : Control
{
public void CanDropDataFw(Vector2 position, object data, Control fromControl)
{
return true;
}
public void DropDataFw(Vector2 position, object data, Control fromControl)
{
MyHandleData(data); // Your handler method.
}
public void GetDragDataFw(Vector2 position, Control fromControl)
{
SetDragPreview(MyPreview);
return MyData();
}
}
Forwards the handling of this control's :ref:`_get_drag_data<class_Control_method__get_drag_data>`, :ref:`_can_drop_data<class_Control_method__can_drop_data>` and :ref:`_drop_data<class_Control_method__drop_data>` virtual functions to delegate callables.
For each argument, if not empty, the delegate callable is used, otherwise the local (virtual) function is used.
The function format for each callable should be exactly the same as the virtual functions described above.
.. rst-class:: classref-item-separator