Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 4e6b407826
Branches Tags
godot-docs
/
classes
/
class_scrollcontainer.rst

class_scrollcontainer.rst 4.5 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_ScrollContainer:
    5. 

  5. 

  6. ScrollContainer
    7. 

  7. ===============
    8. 

  8. 

  9. **Inherits:** :ref:`Container<class_container>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. A helper node for displaying scrollable elements (e.g. lists).
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                     | :ref:`set_enable_h_scroll<class_ScrollContainer_set_enable_h_scroll>`  **(** :ref:`bool<class_bool>` enable  **)** |
    23. 

  23. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`bool<class_bool>`  | :ref:`is_h_scroll_enabled<class_ScrollContainer_is_h_scroll_enabled>`  **(** **)** const                           |
    25. 

  25. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | void                     | :ref:`set_enable_v_scroll<class_ScrollContainer_set_enable_v_scroll>`  **(** :ref:`bool<class_bool>` enable  **)** |
    27. 

  27. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`bool<class_bool>`  | :ref:`is_v_scroll_enabled<class_ScrollContainer_is_v_scroll_enabled>`  **(** **)** const                           |
    29. 

  29. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                     | :ref:`set_h_scroll<class_ScrollContainer_set_h_scroll>`  **(** :ref:`int<class_int>` val  **)**                    |
    31. 

  31. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`    | :ref:`get_h_scroll<class_ScrollContainer_get_h_scroll>`  **(** **)** const                                         |
    33. 

  33. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                     | :ref:`set_v_scroll<class_ScrollContainer_set_v_scroll>`  **(** :ref:`int<class_int>` val  **)**                    |
    35. 

  35. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`int<class_int>`    | :ref:`get_v_scroll<class_ScrollContainer_get_v_scroll>`  **(** **)** const                                         |
    37. 

  37. +--------------------------+--------------------------------------------------------------------------------------------------------------------+
    38. 

  38. 

  39. Description
    40. 

  40. -----------
    41. 

  41. 

  42. A ScrollContainer node with a :ref:`Control<class_control>` child and scrollbar child (:ref:`HScrollbar<class_hscrollbar>`, :ref:`VScrollBar<class_vscrollbar>`, or both) 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 minimum_size of the Control relative to the ScrollContainer.  Works great with a :ref:`Panel<class_panel>` control.
    43. 

  43. 

  44. Member Function Description
    45. 

  45. ---------------------------
    46. 

  46. 

  47. .. _class_ScrollContainer_set_enable_h_scroll:
    48. 

  48. 

  49. - void  **set_enable_h_scroll**  **(** :ref:`bool<class_bool>` enable  **)**
    50. 

  50. 

  51. .. _class_ScrollContainer_is_h_scroll_enabled:
    52. 

  52. 

  53. - :ref:`bool<class_bool>`  **is_h_scroll_enabled**  **(** **)** const
    54. 

  54. 

  55. .. _class_ScrollContainer_set_enable_v_scroll:
    56. 

  56. 

  57. - void  **set_enable_v_scroll**  **(** :ref:`bool<class_bool>` enable  **)**
    58. 

  58. 

  59. .. _class_ScrollContainer_is_v_scroll_enabled:
    60. 

  60. 

  61. - :ref:`bool<class_bool>`  **is_v_scroll_enabled**  **(** **)** const
    62. 

  62. 

  63. .. _class_ScrollContainer_set_h_scroll:
    64. 

  64. 

  65. - void  **set_h_scroll**  **(** :ref:`int<class_int>` val  **)**
    66. 

  66. 

  67. .. _class_ScrollContainer_get_h_scroll:
    68. 

  68. 

  69. - :ref:`int<class_int>`  **get_h_scroll**  **(** **)** const
    70. 

  70. 

  71. .. _class_ScrollContainer_set_v_scroll:
    72. 

  72. 

  73. - void  **set_v_scroll**  **(** :ref:`int<class_int>` val  **)**
    74. 

  74. 

  75. .. _class_ScrollContainer_get_v_scroll:
    76. 

  76. 

  77. - :ref:`int<class_int>`  **get_v_scroll**  **(** **)** const
    78. 

  78. 

  79.