Up to date
This page is up to date for Godot 4.3.
If you still find outdated information, please open an issue.
EditorScrollBox¶
Inherits: BoxContainer < Container < Control < CanvasItem < Node < Object
Inherited By: EditorHScrollBox, EditorVScrollBox
Allow adding a control that can be scrolled horizontally or vertically with buttons.
Description¶
A class used internally by the Editor to allow adding a control that can be scrolled with buttons.
Methods¶
void |
ensure_control_visible(control: Control) |
get_control() const |
|
get_first_button() const |
|
get_scroll_container() const |
|
get_second_button() const |
|
has_control() const |
|
void |
set_control(control: Control) |
Theme Properties¶
Signals¶
vertical_changed(is_vertical: bool) 🔗
Emitted when the alignment of the node is changed.
Method Descriptions¶
void ensure_control_visible(control: Control) 🔗
Ensures the given control is visible.
Note: This will not work on a node that was just added during the same frame. If you want to scroll to a newly added child, you must wait until the next frame using SceneTree.process_frame:
Returns the control node used by the ScrollContainer.
Button get_first_button() const 🔗
Returns the first button used to scroll to the begin.
ScrollContainer get_scroll_container() const 🔗
Returns the ScrollContainer used by the buttons.
Button get_second_button() const 🔗
Returns the second button used to scroll to the end.
There is currently no description for this method. Please help us by contributing one!
void set_control(control: Control) 🔗
Changes the control used by the ScrollContainer.
if null, removes the control used by the ScrollContainer.
Theme Property Descriptions¶
Arrow texture used when scrolling to the end in vertical layout.
Arrow texture used when scrolling to the start in horizontal layout.
Arrow texture used when scrolling to the end in horizontal layout.
Arrow texture used when scrolling to the start in vertical layout.