urho3d/Extras/LuaScript/pkgs/UI/ScrollBar.pkg

$#include "ScrollBar.h"

/// Scroll bar %UI element with forward and back buttons.
class ScrollBar : public UIElement
{
public:
    /// Construct.
    ScrollBar(Context* context);
    /// Destruct.
    virtual ~ScrollBar();
    /// Set orientation type.
    void SetOrientation(Orientation orientation);
    /// Set slider range maximum value (minimum value is always 0.)
    void SetRange(float range);
    /// Set slider current value.
    void SetValue(float value);
    /// Change slider current value by a delta.
    void ChangeValue(float delta);
    /// Set button scroll step.
    void SetScrollStep(float step);
    /// Set button step factor, can be used to adjust the step for constant pixel size.
    void SetStepFactor(float factor);
    /// Scroll back one step.
    void StepBack();
    /// Scroll forward one step.
    void StepForward();
    
    /// Return scrollbar orientation.
    Orientation GetOrientation() const;
    /// Return slider range.
    float GetRange() const;
    /// Return slider current value.
    float GetValue() const;
    /// Return button scroll step.
    float GetScrollStep() const { return scrollStep_; }
    /// Return button step factor.
    float GetStepFactor() const { return stepFactor_; }
    /// Return scroll step multiplied by factor.
    float GetEffectiveScrollStep() const;
    /// Return back button element.
    Button* GetBackButton() const { return backButton_; }
    /// Return forward button element.
    Button* GetForwardButton() const { return forwardButton_; }
    /// Return slider element.
    Slider* GetSlider() const { return slider_; }
};