Class ScrollFrame

A Frame with scrollable content.

This frame has a special child frame, the "scroll child". The scroll child is rendered on a separate render target, which is then rendered on the screen. This allows clipping the content of the scroll child and only display a portion of it (as if scrolling on a page). The displayed portion is controlled by the scroll value, which can be changed in both the vertical and horizontal directions.

By default, the mouse wheel movement will not trigger any scrolling; this has to be explicitly implemented using the OnMouseWheel callback and the ScrollFrame:set_horizontal_scroll function.

Events. Hard-coded events available to all ScrollFrames, in addition to those from Frame:

  • OnHorizontalScroll: Triggered by ScrollFrame:set_horizontal_scroll.
  • OnScrollRangeChanged: Triggered whenever the range of the scroll value changes. This happens either when the size of the scrollable content changes, or when the size of the scroll frame changes.
  • OnVerticalScroll: Triggered by ScrollFrame:set_vertical_scroll.

Inherits all methods from: Region, Frame.

Child classes: none.

Methods

scrollframe:get_horizontal_scroll()
scrollframe:get_horizontal_scroll_range()
scrollframe:get_scroll_child()
scrollframe:get_vertical_scroll()
scrollframe:get_vertical_scroll_range()
scrollframe:set_horizontal_scroll()
scrollframe:set_scroll_child()
scrollframe:set_vertical_scroll()


Methods

scrollframe:get_horizontal_scroll()
scrollframe:get_horizontal_scroll_range()
scrollframe:get_scroll_child()
scrollframe:get_vertical_scroll()
scrollframe:get_vertical_scroll_range()
scrollframe:set_horizontal_scroll()
scrollframe:set_scroll_child()
scrollframe:set_vertical_scroll()
generated by LDoc 1.5.0 Last updated 2023-10-08 09:07:54