Skip to content

Commit

Permalink
Rename Control getters and setters to match properties
Browse files Browse the repository at this point in the history
  • Loading branch information
madmiraal committed May 1, 2021
1 parent 4a7679e commit 80d383e
Show file tree
Hide file tree
Showing 172 changed files with 1,986 additions and 1,988 deletions.
2 changes: 1 addition & 1 deletion doc/classes/AspectRatioContainer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
</constant>
<constant name="STRETCH_COVER" value="3" enum="StretchMode">
The width and height of child controls is automatically adjusted to make their bounding rectangle cover the entire area of the container while keeping the aspect ratio.
When the bounding rectangle of child controls exceed the container's size and [member Control.rect_clip_content] is enabled, this allows to show only the container's area restricted by its own bounding rectangle.
When the bounding rectangle of child controls exceed the container's size and [member Control.rect_clip_contents] is enabled, this allows to show only the container's area restricted by its own bounding rectangle.
</constant>
<constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
Aligns child controls with the beginning (left or top) of the container.
Expand Down
146 changes: 72 additions & 74 deletions doc/classes/Control.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/classes/GraphEdit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@
<member name="minimap_size" type="Vector2" setter="set_minimap_size" getter="get_minimap_size" default="Vector2( 240, 160 )">
The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="rect_clip_contents" type="bool" setter="set_rect_clip_contents" getter="is_rect_clipping_contents" override="true" default="true" />
<member name="right_disconnects" type="bool" setter="set_right_disconnects" getter="is_right_disconnects_enabled" default="false">
If [code]true[/code], enables disconnection of existing connections in the GraphEdit by dragging the right end.
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ItemList.xml
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@
Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display.
[b]Note:[/b] This property takes effect only when [member icon_mode] is [constant ICON_MODE_TOP]. To make the text wrap, [member fixed_column_width] should be greater than zero.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="rect_clip_contents" type="bool" setter="set_rect_clip_contents" getter="is_rect_clipping_contents" override="true" default="true" />
<member name="same_column_width" type="bool" setter="set_same_column_width" getter="is_same_column_width" default="false">
Whether all columns will have the same width.
If [code]true[/code], the width is equal to the largest column width of all columns.
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/Label.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</brief_description>
<description>
Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use [RichTextLabel] instead.
[b]Note:[/b] Contrarily to most other [Control]s, Label's [member Control.mouse_filter] defaults to [constant Control.MOUSE_FILTER_IGNORE] (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured [member Control.hint_tooltip], unless you change its mouse filter.
[b]Note:[/b] Contrarily to most other [Control]s, Label's [member Control.mouse_filter] defaults to [constant Control.MOUSE_FILTER_IGNORE] (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured [member Control.tooltip], unless you change its mouse filter.
</description>
<tutorials>
<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
Expand Down Expand Up @@ -94,7 +94,7 @@
<member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible" default="1.0">
Limits the amount of visible characters. If you set [code]percent_visible[/code] to 0.5, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.
</member>
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="4" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="4" />
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="Control.StructuredTextParser" default="0">
Set BiDi algorithm override for the structured text.
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/LineEdit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length" default="0">
Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" />
<member name="mouse_default_cursor_shape" type="int" setter="set_mouse_default_cursor_shape" getter="get_mouse_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" />
<member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha" default="0.6">
Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code].
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/LinkButton.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="2" />
<member name="mouse_default_cursor_shape" type="int" setter="set_mouse_default_cursor_shape" getter="get_mouse_default_cursor_shape" override="true" enum="Control.CursorShape" default="2" />
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="Control.StructuredTextParser" default="0">
Set BiDi algorithm override for the structured text.
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ProgressBar.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible" default="true">
If [code]true[/code], the fill percentage is displayed on the bar.
</member>
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="0" />
<member name="step" type="float" setter="set_step" getter="get_step" override="true" default="0.01" />
</members>
<constants>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/RichTextLabel.xml
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@
The range of characters to display, as a [float] between 0.0 and 1.0. When assigned an out of range value, it's the same as assigning 1.0.
[b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count].
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="rect_clip_contents" type="bool" setter="set_rect_clip_contents" getter="is_rect_clipping_contents" override="true" default="true" />
<member name="scroll_active" type="bool" setter="set_scroll_active" getter="is_scroll_active" default="true">
If [code]true[/code], the scrollbar is visible. Setting this to [code]false[/code] does not block scrolling completely. See [method scroll_to_line].
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/ScrollBar.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<member name="custom_step" type="float" setter="set_custom_step" getter="get_custom_step" default="-1.0">
Overrides the step used when clicking increment and decrement buttons or when using arrow keys when the [ScrollBar] is focused.
</member>
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="0" />
<member name="step" type="float" setter="set_step" getter="get_step" override="true" default="0.0" />
</members>
<signals>
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/ScrollContainer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</brief_description>
<description>
A ScrollContainer node meant to contain a [Control] child.
ScrollContainers will automatically create a scrollbar child ([HScrollBar], [VScrollBar], or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the [member Control.rect_min_size] of the Control relative to the ScrollContainer.
ScrollContainers will automatically create a scrollbar child ([HScrollBar], [VScrollBar], or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the [member Control.rect_minimum_size] of the Control relative to the ScrollContainer.
Works great with a [Panel] control. You can set [code]EXPAND[/code] on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension).
</description>
<tutorials>
Expand All @@ -30,7 +30,7 @@
<member name="follow_focus" type="bool" setter="set_follow_focus" getter="is_following_focus" default="false">
If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="rect_clip_contents" type="bool" setter="set_rect_clip_contents" getter="is_rect_clipping_contents" override="true" default="true" />
<member name="scroll_deadzone" type="int" setter="set_deadzone" getter="get_deadzone" default="0">
</member>
<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Slider.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<member name="scrollable" type="bool" setter="set_scrollable" getter="is_scrollable" default="true">
If [code]true[/code], the value can be changed using the mouse wheel.
</member>
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="0" />
<member name="tick_count" type="int" setter="set_ticks" getter="get_ticks" default="0">
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/TextEdit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@
<member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80">
The width, in pixels, of the minimap.
</member>
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" />
<member name="mouse_default_cursor_shape" type="int" setter="set_mouse_default_cursor_shape" getter="get_mouse_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" />
<member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color" default="false">
If [code]true[/code], custom [code]font_selected_color[/code] will be used for selected text.
</member>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Tree.xml
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@
<member name="hide_root" type="bool" setter="set_hide_root" getter="is_root_hidden" default="false">
If [code]true[/code], the tree's root is hidden.
</member>
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
<member name="rect_clip_contents" type="bool" setter="set_rect_clip_contents" getter="is_rect_clipping_contents" override="true" default="true" />
<member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="Tree.SelectMode" default="0">
Allows single or multiple selection. See the [enum SelectMode] constants.
</member>
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/VScrollBar.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<methods>
</methods>
<members>
<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="1" />
<member name="size_flags_horizontal" type="int" setter="set_size_flags_horizontal" getter="get_size_flags_horizontal" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="1" />
</members>
<constants>
</constants>
Expand Down
4 changes: 2 additions & 2 deletions doc/classes/VSlider.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<methods>
</methods>
<members>
<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="1" />
<member name="size_flags_horizontal" type="int" setter="set_size_flags_horizontal" getter="get_size_flags_horizontal" override="true" default="0" />
<member name="size_flags_vertical" type="int" setter="set_size_flags_vertical" getter="get_size_flags_vertical" override="true" default="1" />
</members>
<constants>
</constants>
Expand Down
22 changes: 11 additions & 11 deletions editor/action_map_editor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ InputEventConfigurationDialog::InputEventConfigurationDialog() {
tab_container = memnew(TabContainer);
tab_container->set_tab_align(TabContainer::TabAlign::ALIGN_LEFT);
tab_container->set_use_hidden_tabs_for_min_size(true);
tab_container->set_v_size_flags(Control::SIZE_EXPAND_FILL);
tab_container->set_size_flags_vertical(Control::SIZE_EXPAND_FILL);
tab_container->connect("tab_selected", callable_mp(this, &InputEventConfigurationDialog::_tab_selected));
main_vbox->add_child(tab_container);

Expand All @@ -605,20 +605,20 @@ InputEventConfigurationDialog::InputEventConfigurationDialog() {

VBoxContainer *manual_vbox = memnew(VBoxContainer);
manual_vbox->set_name("Manual Selection");
manual_vbox->set_v_size_flags(Control::SIZE_EXPAND_FILL);
manual_vbox->set_size_flags_vertical(Control::SIZE_EXPAND_FILL);
tab_container->add_child(manual_vbox);

input_list_search = memnew(LineEdit);
input_list_search->set_h_size_flags(Control::SIZE_EXPAND_FILL);
input_list_search->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);
input_list_search->set_placeholder(TTR("Filter Inputs"));
input_list_search->set_clear_button_enabled(true);
input_list_search->connect("text_changed", callable_mp(this, &InputEventConfigurationDialog::_search_term_updated));
manual_vbox->add_child(input_list_search);

input_list_tree = memnew(Tree);
input_list_tree->set_custom_minimum_size(Size2(0, 100 * EDSCALE)); // Min height for tree
input_list_tree->set_rect_minimum_size(Size2(0, 100 * EDSCALE)); // Min height for tree
input_list_tree->connect("item_selected", callable_mp(this, &InputEventConfigurationDialog::_input_list_item_selected));
input_list_tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
input_list_tree->set_size_flags_vertical(Control::SIZE_EXPAND_FILL);
manual_vbox->add_child(input_list_tree);

input_list_tree->set_hide_root(true);
Expand All @@ -636,14 +636,14 @@ InputEventConfigurationDialog::InputEventConfigurationDialog() {

// Device Selection
device_container = memnew(HBoxContainer);
device_container->set_h_size_flags(Control::SIZE_EXPAND_FILL);
device_container->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);

Label *device_label = memnew(Label);
device_label->set_text("Device:");
device_container->add_child(device_label);

device_id_option = memnew(OptionButton);
device_id_option->set_h_size_flags(Control::SIZE_EXPAND_FILL);
device_id_option->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);
device_container->add_child(device_id_option);

for (int i = -1; i < 8; i++) {
Expand Down Expand Up @@ -1108,7 +1108,7 @@ ActionMapEditor::ActionMapEditor() {
main_vbox->add_child(top_hbox);

action_list_search = memnew(LineEdit);
action_list_search->set_h_size_flags(Control::SIZE_EXPAND_FILL);
action_list_search->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);
action_list_search->set_placeholder(TTR("Filter Actions"));
action_list_search->set_clear_button_enabled(true);
action_list_search->connect("text_changed", callable_mp(this, &ActionMapEditor::_search_term_updated));
Expand All @@ -1122,10 +1122,10 @@ ActionMapEditor::ActionMapEditor() {

// Adding Action line edit + button
add_hbox = memnew(HBoxContainer);
add_hbox->set_h_size_flags(Control::SIZE_EXPAND_FILL);
add_hbox->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);

add_edit = memnew(LineEdit);
add_edit->set_h_size_flags(Control::SIZE_EXPAND_FILL);
add_edit->set_size_flags_horizontal(Control::SIZE_EXPAND_FILL);
add_edit->set_placeholder(TTR("Add New Action"));
add_edit->set_clear_button_enabled(true);
add_edit->connect("text_entered", callable_mp(this, &ActionMapEditor::_add_action));
Expand All @@ -1140,7 +1140,7 @@ ActionMapEditor::ActionMapEditor() {

// Action Editor Tree
action_tree = memnew(Tree);
action_tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
action_tree->set_size_flags_vertical(Control::SIZE_EXPAND_FILL);
action_tree->set_columns(3);
action_tree->set_hide_root(true);
action_tree->set_column_titles_visible(true);
Expand Down

0 comments on commit 80d383e

Please sign in to comment.