API Documentation
ScrollBar.h
1 // ScrollBar.h
3 //
5 
6 namespace nkWinUi
7 {
11  class ScrollBar : public Component
12  {
13  public :
14 
22  ScrollBar (System* system) noexcept ;
26  virtual ~ScrollBar () ;
27 
28  // Getters
32  int getCurrentMin () const ;
36  int getCurrentMax () const ;
37 
38  // Setters
44  virtual void setMin (int value) ;
50  virtual void setMax (int value) ;
57  virtual void setActiveRange (int value) ;
66  void setScrollCallback (std::function<void (ScrollBar*)> callback) ;
70  virtual void scrollToMin () ;
74  virtual void scrollToMax () ;
80  virtual void setScrollFactor (float value) = 0 ;
86  virtual void moveCurrentMinTo (int value) ;
92  virtual void moveCurrentMaxTo (int value) ;
93 
99  virtual void scroll (float factor) = 0 ;
100 
101  public :
102 
103  // Statics
111  static nkMemory::UniquePtr<ScrollBar> create (System* system = nullptr) ;
112  } ;
113 }
nkWinUi::ScrollBar::setMin
virtual void setMin(int value)
nkWinUi::ScrollBar::moveCurrentMaxTo
virtual void moveCurrentMaxTo(int value)
nkWinUi::ScrollBar::setScrollCallback
void setScrollCallback(std::function< void(ScrollBar *)> callback)
nkWinUi::ScrollBar
A graphical scroll bar.
Definition: ScrollBar.h:12
nkWinUi::ScrollBar::scroll
virtual void scroll(float factor)=0
nkWinUi::ScrollBar::~ScrollBar
virtual ~ScrollBar()
nkWinUi::Component
Base class for any graphical component.
Definition: Component.h:12
nkWinUi::ScrollBar::scrollToMin
virtual void scrollToMin()
nkWinUi::ScrollBar::create
static nkMemory::UniquePtr< ScrollBar > create(System *system=nullptr)
nkWinUi::System
The main system of the component.
Definition: System.h:18
nkWinUi::ScrollBar::setScrollFactor
virtual void setScrollFactor(float value)=0
nkWinUi::ScrollBar::setActiveRange
virtual void setActiveRange(int value)
nkWinUi::ScrollBar::setMax
virtual void setMax(int value)
nkWinUi::ScrollBar::getCurrentMin
int getCurrentMin() const
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkWinUi::ScrollBar::moveCurrentMinTo
virtual void moveCurrentMinTo(int value)
nkWinUi::ScrollBar::ScrollBar
ScrollBar(System *system) noexcept
nkWinUi::ScrollBar::scrollToMax
virtual void scrollToMax()
nkWinUi::ScrollBar::getCurrentMax
int getCurrentMax() const
nkWinUi
Encompasses all API of component NilkinsWinUi.
Definition: Clipboard.h:7