.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/ScrollContainer.xml. .. _class_ScrollContainer: ScrollContainer =============== **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`EditorInspector` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | clip_contents | ``true`` (overrides :ref:`Control`) | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`bool` | :ref:`follow_focus` | ``false`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`ScrollMode` | :ref:`horizontal_scroll_mode` | ``1`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`int` | :ref:`scroll_deadzone` | ``0`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`int` | :ref:`scroll_horizontal` | ``0`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`scroll_horizontal_custom_step` | ``-1.0`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`int` | :ref:`scroll_vertical` | ``0`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`float` | :ref:`scroll_vertical_custom_step` | ``-1.0`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`ScrollMode` | :ref:`vertical_scroll_mode` | ``1`` | +----------------------------------------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`ensure_control_visible` **(** :ref:`Control` control **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`HScrollBar` | :ref:`get_h_scroll_bar` **(** **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VScrollBar` | :ref:`get_v_scroll_bar` **(** **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+-------------------------------------------------------+ | :ref:`StyleBox` | :ref:`panel` | +---------------------------------+-------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ScrollContainer_signal_scroll_ended: .. rst-class:: classref-signal **scroll_ended** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_signal_scroll_started: .. rst-class:: classref-signal **scroll_started** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ScrollContainer_ScrollMode: .. rst-class:: classref-enumeration enum **ScrollMode**: .. _class_ScrollContainer_constant_SCROLL_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`ScrollMode` **SCROLL_MODE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ScrollContainer_constant_SCROLL_MODE_AUTO: .. rst-class:: classref-enumeration-constant :ref:`ScrollMode` **SCROLL_MODE_AUTO** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ScrollContainer_constant_SCROLL_MODE_SHOW_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ScrollMode` **SCROLL_MODE_SHOW_ALWAYS** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ScrollContainer_constant_SCROLL_MODE_SHOW_NEVER: .. rst-class:: classref-enumeration-constant :ref:`ScrollMode` **SCROLL_MODE_SHOW_NEVER** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ScrollContainer_property_follow_focus: .. rst-class:: classref-property :ref:`bool` **follow_focus** = ``false`` .. rst-class:: classref-property-setget - void **set_follow_focus** **(** :ref:`bool` value **)** - :ref:`bool` **is_following_focus** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_horizontal_scroll_mode: .. rst-class:: classref-property :ref:`ScrollMode` **horizontal_scroll_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_horizontal_scroll_mode** **(** :ref:`ScrollMode` value **)** - :ref:`ScrollMode` **get_horizontal_scroll_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_scroll_deadzone: .. rst-class:: classref-property :ref:`int` **scroll_deadzone** = ``0`` .. rst-class:: classref-property-setget - void **set_deadzone** **(** :ref:`int` value **)** - :ref:`int` **get_deadzone** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_scroll_horizontal: .. rst-class:: classref-property :ref:`int` **scroll_horizontal** = ``0`` .. rst-class:: classref-property-setget - void **set_h_scroll** **(** :ref:`int` value **)** - :ref:`int` **get_h_scroll** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_scroll_horizontal_custom_step: .. rst-class:: classref-property :ref:`float` **scroll_horizontal_custom_step** = ``-1.0`` .. rst-class:: classref-property-setget - void **set_horizontal_custom_step** **(** :ref:`float` value **)** - :ref:`float` **get_horizontal_custom_step** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_scroll_vertical: .. rst-class:: classref-property :ref:`int` **scroll_vertical** = ``0`` .. rst-class:: classref-property-setget - void **set_v_scroll** **(** :ref:`int` value **)** - :ref:`int` **get_v_scroll** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_scroll_vertical_custom_step: .. rst-class:: classref-property :ref:`float` **scroll_vertical_custom_step** = ``-1.0`` .. rst-class:: classref-property-setget - void **set_vertical_custom_step** **(** :ref:`float` value **)** - :ref:`float` **get_vertical_custom_step** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_property_vertical_scroll_mode: .. rst-class:: classref-property :ref:`ScrollMode` **vertical_scroll_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_vertical_scroll_mode** **(** :ref:`ScrollMode` value **)** - :ref:`ScrollMode` **get_vertical_scroll_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ScrollContainer_method_ensure_control_visible: .. rst-class:: classref-method void **ensure_control_visible** **(** :ref:`Control` control **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_method_get_h_scroll_bar: .. rst-class:: classref-method :ref:`HScrollBar` **get_h_scroll_bar** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ScrollContainer_method_get_v_scroll_bar: .. rst-class:: classref-method :ref:`VScrollBar` **get_v_scroll_bar** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_ScrollContainer_theme_style_panel: .. rst-class:: classref-themeproperty :ref:`StyleBox` **panel** .. container:: contribute There is currently no description for this theme property. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`