ScrollBar.pkg 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. $#include "ScrollBar.h"
  2. /// Scroll bar %UI element with forward and back buttons.
  3. class ScrollBar : public UIElement
  4. {
  5. public:
  6. /// Set orientation type.
  7. void SetOrientation(Orientation orientation);
  8. /// Set slider range maximum value (minimum value is always 0.)
  9. void SetRange(float range);
  10. /// Set slider current value.
  11. void SetValue(float value);
  12. /// Change slider current value by a delta.
  13. void ChangeValue(float delta);
  14. /// Set button scroll step.
  15. void SetScrollStep(float step);
  16. /// Set button step factor, can be used to adjust the step for constant pixel size.
  17. void SetStepFactor(float factor);
  18. /// Scroll back one step.
  19. void StepBack();
  20. /// Scroll forward one step.
  21. void StepForward();
  22. /// Return scrollbar orientation.
  23. Orientation GetOrientation() const;
  24. /// Return slider range.
  25. float GetRange() const;
  26. /// Return slider current value.
  27. float GetValue() const;
  28. /// Return button scroll step.
  29. float GetScrollStep() const { return scrollStep_; }
  30. /// Return button step factor.
  31. float GetStepFactor() const { return stepFactor_; }
  32. /// Return scroll step multiplied by factor.
  33. float GetEffectiveScrollStep() const;
  34. /// Return back button element.
  35. Button* GetBackButton() const { return backButton_; }
  36. /// Return forward button element.
  37. Button* GetForwardButton() const { return forwardButton_; }
  38. /// Return slider element.
  39. Slider* GetSlider() const { return slider_; }
  40. };