Unigine.WidgetScrollBox Class
| Inherits from: | Widget |
This class creates a scroll box.
The object of this class looks as follows:
See Also#
- UnigineScript API sample <UnigineSDK>/data/samples/widgets/scroll_00
WidgetScrollBox Class
Enums
SCROLL_RENDER_MODE#
| Name | Description |
|---|---|
| ALWAYS_RENDER = 0 | |
| AUTO_HIDE = 1 | |
| ALWAYS_HIDE = 2 | |
| ALWAYS_HIDE_NO_BOUNDS = 3 |
Properties
WidgetScroll HScroll#
The horizontal scroller object.
int HScrollValue#
The position (and also automatically the size) of the horizontal scroller. That is, it returns the width of the currently invisible area that determines the size of the slider.
int HScrollStepSize#
The step of the horizontal scroller. This step is used to increment the scroll position.
int HScrollFrameSize#
The width of the currently visible area.
int HScrollObjectSize#
The width of the whole object that should be scrolled.
WidgetScrollBox.SCROLL_RENDER_MODE HScrollHidden#
The flag indicating if a horizontal scroll bar is hidden, disabled or always rendered.
bool HScrollEnabled#
The value indicating if horizontal scrolling is enabled.
WidgetScroll VScroll#
The vetical scroller object.
int VScrollValue#
The position (and also the size) of the vertical scroller. That is, it returns the height of the currently invisible area that determines the size of the slider.
int VScrollStepSize#
The step of the vertical scroller. This step is used to increment the scroll position.
int VScrollFrameSize#
The height of the currently visible area.
int VScrollObjectSize#
The height of the whole object that should be scrolled.
WidgetScrollBox.SCROLL_RENDER_MODE VScrollHidden#
The flag indicating if a vertical scroll bar is hidden, disabled or always rendered.
bool VScrollEnabled#
The value indicating if vertical scrolling is enabled.
int ScrollScale#
The divisor used to convert integer values into floating point values.
int Background#
The value indicating if the background is rendered.
int Border#
The flag indicating if a one-pixel border is rendered around the widget content (in a shape of a box). The default is 1 (use a border).
int PaddingBottom#
The bottom padding for the widget content.
int PaddingTop#
The top padding for the widget content.
int PaddingRight#
The right-side padding for the widget content.
int PaddingLeft#
The left-side padding for the widget content.
vec4 VscrollColor#
The color used for the widget's vertical scroll.
vec4 HscrollColor#
The color used for the widget's horizontal scroll.
vec4 BackgroundColor#
The background color used for the widget.
vec4 BorderColor#
The border color for the widget.
int SpaceY#
The vertical space between the widgets in the box and between them and the box border.
int SpaceX#
The horizontal space between the widgets in the box and between them and the box border.
Members
WidgetScrollBox ( Gui gui, int x = 0, int y = 0 ) #
Constructor. Creates a box with scrolling based on given parameters and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the new box will belong.
- int x - Horizontal space between the widgets in the box and between them and the box border. This is an optional parameter.
- int y - Vertical space between the widgets in the box and between them and the box border. This is an optional parameter.
WidgetScrollBox ( int x = 0, int y = 0 ) #
Constructor. Creates a box with scrolling based on given parameters and adds it to the Engine GUI.Arguments
- int x - Horizontal space between the widgets in the box and between them and the box border. This is an optional parameter.
- int y - Vertical space between the widgets in the box and between them and the box border. This is an optional parameter.
void SetPadding ( int l, int r, int t, int b ) #
Sets widget paddings for all sides. Padding clears an area around the content of a widget (inside of it).Arguments
- int l - Left-side padding in pixels.
- int r - Right-side padding in pixels.
- int t - Top padding in pixels.
- int b - Bottom padding in pixels.
void SetSpace ( int x, int y ) #
Sets a space between the widgets in the box and between them and the box border.Arguments
- int x - Horizontal space. If a negative value is specified, 0 will be used instead.
- int y - Vertical space. If a negative value is specified, 0 will be used instead.
Last update:
2024-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)