godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ScrollContainer.xml

80 lines
4.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref headers with 3.4 version
2021-04-26 11:14:51 +00:00
<class name="ScrollContainer" inherits="Container" version="3.4">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
A helper node for displaying scrollable elements such as lists.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
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. 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).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
ScrollContainer: Expose `_ensure_focused_visible` to the API Was renamed to `ensure_control_visible`
2021-05-15 03:19:23 +00:00
<method name="ensure_control_visible">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="control" type="Control" />
ScrollContainer: Expose `_ensure_focused_visible` to the API Was renamed to `ensure_control_visible`
2021-05-15 03:19:23 +00:00
<description>
Ensures the given [code]control[/code] is visible (must be a direct or indirect child of the ScrollContainer). Used by [member follow_focus].
Document how to autoscroll ScrollContainer. It is not uncommon to want to scroll to the most recently added child of a ScrollContainer (e.g. a chat box or activity log). This is a little tricky, since `ensure_control_visible` will not work on a node on the same frame as you add it. Let's at least document that you need to wait until the next frame. Relates to https://github.com/godotengine/godot-proposals/issues/3629. Backport of https://github.com/godotengine/godot/pull/55609. Co-authored-by: Yuri Sizov <pycbouh@users.noreply.github.com> (cherry picked from commit 22fb04bddf3e296d466409258eaadf8bb48e0fb7)
2021-12-04 00:07:01 +00:00
[b]Note:[/b] 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 [signal SceneTree.idle_frame]:
[codeblock]
add_child(child_node)
yield(get_tree(), "idle_frame")
ensure_control_visible(child_node)
[/codeblock]
ScrollContainer: Expose `_ensure_focused_visible` to the API Was renamed to `ensure_control_visible`
2021-05-15 03:19:23 +00:00
</description>
</method>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 16:41:16 +00:00
<method name="get_h_scrollbar">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="HScrollBar" />
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 16:41:16 +00:00
<description>
Update ScrollContainer.xml Add missing descriptions to ScrollContainer documentation
2020-01-24 16:21:53 +00:00
Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer].
Add warnings to methods that give access to internal nodes
2021-10-10 20:10:07 +00:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use [member scroll_horizontal_enabled]. If you want to only hide it instead, use its [member CanvasItem.visible] property.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 16:41:16 +00:00
</description>
</method>
<method name="get_v_scrollbar">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="VScrollBar" />
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 16:41:16 +00:00
<description>
Update ScrollContainer.xml Add missing descriptions to ScrollContainer documentation
2020-01-24 16:21:53 +00:00
Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer].
Add warnings to methods that give access to internal nodes
2021-10-10 20:10:07 +00:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use [member scroll_vertical_enabled]. If you want to only hide it instead, use its [member CanvasItem.visible] property.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 16:41:16 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
<members>
Make new ScrollContainer focus behavior optional
2019-12-23 23:03:24 +00:00
<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>
doc: Sync classref with current source
2020-01-03 14:09:03 +00:00
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" override="true" default="true" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scroll_deadzone" type="int" setter="set_deadzone" getter="get_deadzone" default="0">
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
The current horizontal scroll value.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scroll_horizontal_enabled" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled" default="true">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
If [code]true[/code], enables horizontal scrolling.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scroll_vertical" type="int" setter="set_v_scroll" getter="get_v_scroll" default="0">
Fix Error in the ScrollContainer Tooltips
2018-05-12 08:45:56 +00:00
The current vertical scroll value.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scroll_vertical_enabled" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled" default="true">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
If [code]true[/code], enables vertical scrolling.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
<signals>
<signal name="scroll_ended">
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Emitted when scrolling stops.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</description>
</signal>
<signal name="scroll_started">
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Emitted when scrolling is started.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="bg" data_type="style" type="StyleBox">
Document theme_items of multiple classes
2020-01-27 01:15:37 +00:00
The background [StyleBox] of the [ScrollContainer].
Sync classref with current source Also fix binding of Basis.slerp
2018-05-28 12:53:15 +00:00
</theme_item>
</theme_items>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</class>