diff options
Diffstat (limited to 'doc/classes/Control.xml')
| -rw-r--r-- | doc/classes/Control.xml | 302 |
1 files changed, 0 insertions, 302 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 27a6eee932..8e0ac2bfb3 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -137,15 +137,6 @@ <description> </description> </method> - <method name="get_anchor" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). - </description> - </method> <method name="get_begin" qualifiers="const"> <return type="Vector2"> </return> @@ -187,12 +178,6 @@ Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. </description> </method> - <method name="get_custom_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> <method name="get_default_cursor_shape" qualifiers="const"> <return type="int" enum="Control.CursorShape"> </return> @@ -222,22 +207,6 @@ Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). </description> </method> - <method name="get_focus_neighbour" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return the forced neighbour for moving the input focus to. When pressing directional/joypad directions, focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - </description> - </method> - <method name="get_focus_next" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return the 'focus_next' for moving input focus to. When pressing TAB, focus is moved to the next control in the tree. However, the control to move to can be forced with this function. - </description> - </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> @@ -245,13 +214,6 @@ Return which control is owning the keyboard focus, or null if no one. </description> </method> - <method name="get_focus_previous" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - Return the 'focus_previous' for moving input focus to. When pressing Shift+TAB focus is moved to the previous control in the tree. However, the control to move to can be forced with this function. - </description> - </method> <method name="get_font" qualifiers="const"> <return type="Font"> </return> @@ -276,19 +238,6 @@ Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]). </description> </method> - <method name="get_h_grow_direction" qualifiers="const"> - <return type="int" enum="Control.GrowDirection"> - </return> - <description> - </description> - </method> - <method name="get_h_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Hint for containers, return horizontal positioning flags. - </description> - </method> <method name="get_icon" qualifiers="const"> <return type="Texture"> </return> @@ -299,15 +248,6 @@ <description> </description> </method> - <method name="get_margin" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <description> - Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. - </description> - </method> <method name="get_minimum_size" qualifiers="const"> <return type="Vector2"> </return> @@ -315,13 +255,6 @@ Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> - <method name="get_mouse_filter" qualifiers="const"> - <return type="int" enum="Control.MouseFilter"> - </return> - <description> - Return when the control is ignoring mouse events (even touchpad events send mouse events). - </description> - </method> <method name="get_parent_area_size" qualifiers="const"> <return type="Vector2"> </return> @@ -334,19 +267,6 @@ <description> </description> </method> - <method name="get_pivot_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. - </description> - </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -361,33 +281,6 @@ Return the rotation (in radians) </description> </method> - <method name="get_rotation_degrees" qualifiers="const"> - <return type="float"> - </return> - <description> - Return the rotation (in degrees) - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by[/b] [method get_minimum_size]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). - </description> - </method> - <method name="get_stretch_ratio" qualifiers="const"> - <return type="float"> - </return> - <description> - Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - </description> - </method> <method name="get_stylebox" qualifiers="const"> <return type="StyleBox"> </return> @@ -398,13 +291,6 @@ <description> </description> </method> - <method name="get_theme" qualifiers="const"> - <return type="Theme"> - </return> - <description> - Return a [Theme] override, if one exists (see [method set_theme]). - </description> - </method> <method name="get_tooltip" qualifiers="const"> <return type="String"> </return> @@ -414,19 +300,6 @@ Return the tooltip, which will appear when the cursor is resting over this control. </description> </method> - <method name="get_v_grow_direction" qualifiers="const"> - <return type="int" enum="Control.GrowDirection"> - </return> - <description> - </description> - </method> - <method name="get_v_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - Hint for containers, return vertical positioning flags. - </description> - </method> <method name="grab_click_focus"> <return type="void"> </return> @@ -545,12 +418,6 @@ <description> </description> </method> - <method name="is_clipping_contents"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="minimum_size_changed"> <return type="void"> </return> @@ -623,22 +490,6 @@ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> - <method name="set_clip_contents"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_custom_minimum_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> <method name="set_default_cursor_shape"> <return type="void"> </return> @@ -682,35 +533,6 @@ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. </description> </method> - <method name="set_focus_neighbour"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="neighbour" type="NodePath"> - </argument> - <description> - Force a neighbour for moving the input focus to. When pressing directional/joypad directions, focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. - </description> - </method> - <method name="set_focus_next"> - <return type="void"> - </return> - <argument index="0" name="next" type="NodePath"> - </argument> - <description> - Force the 'focus_next' for moving input focus to. When pressing TAB, focus is moved to the next control in the tree. However, the control to move to can be forced with this function. - </description> - </method> - <method name="set_focus_previous"> - <return type="void"> - </return> - <argument index="0" name="previous" type="NodePath"> - </argument> - <description> - Force the 'focus_previous' for moving input focus to. When pressing Shift+TAB, focus is moved to the previous control in the tree. However, the control to move to can be forced with this function. - </description> - </method> <method name="set_global_position"> <return type="void"> </return> @@ -720,34 +542,6 @@ Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). </description> </method> - <method name="set_h_grow_direction"> - <return type="void"> - </return> - <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> - </argument> - <description> - </description> - </method> - <method name="set_h_size_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Hint for containers, set horizontal positioning flags. - </description> - </method> - <method name="set_margin"> - <return type="void"> - </return> - <argument index="0" name="margin" type="int" enum="Margin"> - </argument> - <argument index="1" name="offset" type="float"> - </argument> - <description> - Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. - </description> - </method> <method name="set_margins_preset"> <return type="void"> </return> @@ -760,32 +554,6 @@ <description> </description> </method> - <method name="set_mouse_filter"> - <return type="void"> - </return> - <argument index="0" name="filter" type="int" enum="Control.MouseFilter"> - </argument> - <description> - Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) - </description> - </method> - <method name="set_pivot_offset"> - <return type="void"> - </return> - <argument index="0" name="pivot_offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]). - </description> - </method> <method name="set_rotation"> <return type="void"> </return> @@ -795,76 +563,6 @@ Set the rotation (in radians). </description> </method> - <method name="set_rotation_degrees"> - <return type="void"> - </return> - <argument index="0" name="degrees" type="float"> - </argument> - <description> - Set the rotation (in degrees). - </description> - </method> - <method name="set_scale"> - <return type="void"> - </return> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_size"> - <return type="void"> - </return> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). - </description> - </method> - <method name="set_stretch_ratio"> - <return type="void"> - </return> - <argument index="0" name="ratio" type="float"> - </argument> - <description> - Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. - </description> - </method> - <method name="set_theme"> - <return type="void"> - </return> - <argument index="0" name="theme" type="Theme"> - </argument> - <description> - Overrides the whole [Theme] for this node and all its [code]Control[/code] children. - </description> - </method> - <method name="set_tooltip"> - <return type="void"> - </return> - <argument index="0" name="tooltip" type="String"> - </argument> - <description> - Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments. - </description> - </method> - <method name="set_v_grow_direction"> - <return type="void"> - </return> - <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> - </argument> - <description> - </description> - </method> - <method name="set_v_size_flags"> - <return type="void"> - </return> - <argument index="0" name="flags" type="int"> - </argument> - <description> - Hint for containers, set vertical positioning flags. - </description> - </method> <method name="show_modal"> <return type="void"> </return> |