Scrollbar/Slider Control. More...
Public Types | |
| enum | Axes |
| XAxis - horizontal, YAxis - vertical. More... | |
Public Member Functions | |
| void | SetScrollPercentWithoutEvent (float newScrollPercent) |
| Manually set scrolling percent without firing OnScroll event. | |
Public Attributes | |
| tk2dUIItem | barUIItem |
| Whole bar uiItem. Used to record clicks/touches to move thumb directly to that locations. | |
| float | scrollBarLength |
| Lenght of the scrollbar. | |
| tk2dUIItem | thumbBtn |
| Scroll thumb button. Events will be taken from this. | |
| Transform | thumbTransform |
| Generally same as thumbBtn, but sometimes you want a thumb that user can't interactive with. | |
| float | thumbLength |
| Length of the scroll thumb. | |
| tk2dUIItem | upButton |
| Button up, moves list up. Not required. | |
| tk2dUIItem | downButton |
| Button down, moves list down. Not required. | |
| float | buttonUpDownScrollDistance = 1f |
| Disable up/down buttons will scroll. | |
| bool | allowScrollWheel = true |
| Allows for mouse scroll wheel to scroll list while hovered. Requires hover to be active. | |
| Axes | scrollAxes = Axes.YAxis |
| Axes while scrolling will occur. | |
| tk2dUIProgressBar | highlightProgressBar |
| Highlighted progress bar control used to move a highlighted bar. Not required. | |
Properties | |
| float | Value [get, set] |
| Percent scrolled. 0-1. | |
Events | |
| System.Action< tk2dUIScrollbar > | OnScroll |
| Event, on scrolling. | |
Detailed Description
Scrollbar/Slider Control.
Member Enumeration Documentation
| enum tk2dUIScrollbar.Axes |
XAxis - horizontal, YAxis - vertical.
Member Function Documentation
| void tk2dUIScrollbar.SetScrollPercentWithoutEvent | ( | float | newScrollPercent | ) |
Manually set scrolling percent without firing OnScroll event.
Member Data Documentation
| bool tk2dUIScrollbar.allowScrollWheel = true |
Allows for mouse scroll wheel to scroll list while hovered. Requires hover to be active.
Whole bar uiItem. Used to record clicks/touches to move thumb directly to that locations.
| float tk2dUIScrollbar.buttonUpDownScrollDistance = 1f |
Disable up/down buttons will scroll.
Button down, moves list down. Not required.
| tk2dUIProgressBar tk2dUIScrollbar.highlightProgressBar |
Highlighted progress bar control used to move a highlighted bar. Not required.
| Axes tk2dUIScrollbar.scrollAxes = Axes.YAxis |
Axes while scrolling will occur.
Lenght of the scrollbar.
Scroll thumb button. Events will be taken from this.
Length of the scroll thumb.
| Transform tk2dUIScrollbar.thumbTransform |
Generally same as thumbBtn, but sometimes you want a thumb that user can't interactive with.
Button up, moves list up. Not required.
Property Documentation
float tk2dUIScrollbar.Value [get, set] |
Percent scrolled. 0-1.
Event Documentation
| System.Action<tk2dUIScrollbar> tk2dUIScrollbar.OnScroll |
Event, on scrolling.
