diff options
| author | VolTer <mew.pur.pur@abv.bg> | 2023-04-30 16:26:09 +0200 |
|---|---|---|
| committer | VolTer <mew.pur.pur@abv.bg> | 2023-05-28 14:24:54 +0200 |
| commit | 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79 (patch) | |
| tree | e5d78c825e09d7718156870377155dbc2331518a /doc/classes/ScrollContainer.xml | |
| parent | a67d37f7cffe7f31c68e971280950d487ea99e2c (diff) | |
| download | redot-engine-151a4ba6a59f6e965bb56ce8fbc75b14d056fa79.tar.gz | |
Overhaul the top sections of the class reference (GUI classes)
Diffstat (limited to 'doc/classes/ScrollContainer.xml')
| -rw-r--r-- | doc/classes/ScrollContainer.xml | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index cfc4ca6b4f..9026f4a5d0 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -1,15 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ScrollContainer" inherits="Container" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - A helper node for displaying scrollable elements such as lists. + A container used to provide scrollbars to a child control when needed. </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.custom_minimum_size] of the Control relative to the ScrollContainer. - Works great with a [Panel] control. You can set [constant Control.SIZE_EXPAND] 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). + A container used to provide a child control with scrollbars when needed. 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.custom_minimum_size] of the Control relative to the ScrollContainer. </description> <tutorials> - <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> + <link title="Using Containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="ensure_control_visible"> |