Unigine.WidgetScroll Class
| Inherits: | Widget |
This class creates a scrollbar: horizontal or vertical one.
WidgetScroll Class
Properties
int Value#
The value of the scroller, i.e. its position.
set
Sets a value of the scroller, i.e. its position.
set value -
Position of the scroller. The minimum value is 0, the maximum value is the difference between the object width and the frame width.
int StepSize#
The step of the scroller. this step is used to increment the scroll position.
set
Sets the step of the scroller. This step is used to increment the scroll position.
set value -
Step of the scroller in pixels. The minimum is 1 pixel.
int FrameSize#
The size of the currently visible area.
set
Sets the size of the currently visible area.
set value -
Size of the visible area in pixels. The minimum is 1 pixel.
int ObjectSize#
The size of the whole area that is scrolled through.
set
Sets the size of the whole area to be scrolled through.
set value -
Size of the object being scrolled in pixels. The minimum is 1 pixel.
int Orientation#
The current orientation of the scroller: horizontal or vertical one.
set
Sets orientation of the scroller: horizontal (by default) or vertical one.
set value -
1 to set horizontal orientation; 0 to set vertical one.
vec4 ScrollColor#
Returns the current color used for the widget's scroll.
set
Sets the color to be used for the widget's scroll.
set value -
Four-component vector specifying the color in the RGBA format.
Members
static WidgetScroll ( Gui gui, int object = 100, int frame = 10, int step = 1, int value = 0 ) #
Constructor. Creates a scroller with the given parameters.Arguments
- Gui gui - GUI, to which the scroll bar will belong.
- int object - Width of the object to scroll in pixels. This is an optional argument.
- int frame - Width of the visible area in pixels. This is an optional argument.
- int step - Step of the scroller in pixels. This is an optional argument.
- int value - Initial position of the scroller. This is an optional argument.
void SetScrollColor ( vec4 color ) #
Sets the color to be used for the widget's scroll.Arguments
- vec4 color - Four-component vector specifying the color in the RGBA format.
vec4 GetScrollColor ( ) #
Returns the current color used for the widget's scroll.Return value
Four-component vector specifying the color in the RGBA format.Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)