SliderBar
The SliderBar provides an Windows style slider bar control. This Window element is an automated combination of several other window components.
| SliderBar | The SliderBar provides an Windows style slider bar control. |
| Implementation Details | The SliderBar is a combination window element that automates slider-box behavior from a set of more basic window components. |
| XML Definition | This is the SliderBar xml definition. |
| XML Tag | |
| Required Attributes | You need to specify valid values for all of these elements to get the SliderBar to create properly. |
| background | The name of a <HorizontalResizeIMage> definition for the bar background image. |
| tickmark | The name of a DynamicImage definition that contains the texture coorddnates and size for a single tick mark |
| sliderbutton | The name of a Button definition for the slider button |
| numticks | The number of tickmarks to display along the bar. |
| orientation | Changes the internal functions to behave as if the slider bar was oriented horizontally or vertically. |
| locktoticks | Causes the slider bar to only move to values the ticks are located at. |
| Window Callbacks | These are the SliderBar specific callback events. |
| Callbacks | |
| OnSlide | Called when the bar’s position changes. |
| Functions | |
| SliderBarSetDisabledFlag() | Sets if slider is disabled. |
| SliderBarGetDisabledFlag() | Returns if the slider is currently set to disabled. |
| Functions | |
| Functions | |
| SliderBarSetCurrentPosition() | Sets the current position for the slider bar, |
| SliderBarGetCurrentPosition() | Returns the current position for the slider bar, |
Implementation Details
The SliderBar is a combination window element that automates slider-box behavior from a set of more basic window components.
Components
The SliderBar is comprised of the following components:
- A HorizontalResizeImage definition for the ‘bar’ background. This is sized to fit the width of the window.
- A DynamicImage defintion to describe a single tick mark. This will be tiled appropriately according to the numticks
- A Button definition for the slider button.
Values
The slider maintains its position as a value betweeen 0.0 (all the way to the left) and 1.0 (all the way to the right). If you wisht to use the slider for other ranges of values, you should do your calculation in your lua script.
Notes
XML Definition
This is the SliderBar xml definition.
| XML Tag | |
| Required Attributes | You need to specify valid values for all of these elements to get the SliderBar to create properly. |
| background | The name of a <HorizontalResizeIMage> definition for the bar background image. |
| tickmark | The name of a DynamicImage definition that contains the texture coorddnates and size for a single tick mark |
| sliderbutton | The name of a Button definition for the slider button |
| numticks | The number of tickmarks to display along the bar. |
| orientation | Changes the internal functions to behave as if the slider bar was oriented horizontally or vertically. |
| locktoticks | Causes the slider bar to only move to values the ticks are located at. |
Required Attributes
You need to specify valid values for all of these elements to get the SliderBar to create properly.
background
The name of a <HorizontalResizeIMage> definition for the bar background image.
Expects
A string value, which is the name of a valid <HorizontalResizeIMage>.
Default Value
- ””
tickmark
The name of a DynamicImage definition that contains the texture coorddnates and size for a single tick mark
Expects
A string value, which is the name of a valid DynamicImage.
Default Value
- ””
orientation
Changes the internal functions to behave as if the slider bar was oriented horizontally or vertically. SliderBars using an inappropriate orientation may render strangely but should function the same.
Expects
”horizontal” or “vertical”, substrings of these may or may not function
Default Value
- ”horizontal”
locktoticks
Causes the slider bar to only move to values the ticks are located at.
Expects
”true” or “false”
Default Value
- ”false”
Window Callbacks
These are the SliderBar specific callback events.
| Callbacks | |
| OnSlide | Called when the bar’s position changes. |
| Functions | |
| SliderBarSetDisabledFlag() | Sets if slider is disabled. |
| SliderBarGetDisabledFlag() | Returns if the slider is currently set to disabled. |
OnSlide
Called when the bar’s position changes.
Syntax
SomeSliderBar.OnSlide( curPos )
| curPos | (number) The current slide position. |
SliderBarSetDisabledFlag()
Sets if slider is disabled. When disabled, the slider button cannot slide.
Parameters
| sliderName | (string) The name of the slider. |
| isDisabled. | (boolean) Should the slider be disabled? |
Returns
| nil | no return value |
Notes
- Setting a slider to disabled does not update it’s artwork. It prevents the slider button from moving.
Example
SliderBarSetDisabledFlag("MySlider", false )SliderBarGetDisabledFlag()
Returns if the slider is currently set to disabled.
Parameters
| sliderName | (string) The name of the slider. |
Returns
| isDisabled. | (boolean) Is the slider currently disabled? |
Notes
- none
Example
local isDisabled = SliderBarSetDisabledFlag("MySlider")Functions
| Functions | |
| SliderBarSetCurrentPosition() | Sets the current position for the slider bar, |
| SliderBarGetCurrentPosition() | Returns the current position for the slider bar, |
SliderBarSetCurrentPosition()
Sets the current position for the slider bar,
Parameters
| sliderBarName | (string) The name of the SliderBar. |
| position | (number) The desired position, a value between 0.0 (all the way to the left) and 1.0 (all the way to the right). |
Returns
| nil | no return value |
Notes
- none
Example
SliderBarSetCurrentPosition("ScenarioMapMenuWindowOpacitySlider", SystemData.Settings.Interface.tacticalMapAlpha)SliderBarGetCurrentPosition()
Returns the current position for the slider bar,
Parameters
| sliderBarName | (string) The name of the SliderBar. |
Returns
| position | (number) The current position, a value between 0.0 (all the way to the left) and 1.0 (all the way to the right). |
Notes
- returns nil on failure
Example
local value = SliderBarGetCurrentPosition( "ScenarioMapMenuWindowOpacitySlider" )