Lysa UI  0.0
Lysa UI —UI components for the Lysa Engine
ValueSelect Class Reference

Detailed Description

Base class for widgets that allow selecting a numeric value within a range.

+ Inheritance diagram for ValueSelect:

Public Member Functions

 ValueSelect (Type type, float min, float max, float value, float step)
 
auto getMin () const
 
auto getMax () const
 
auto getValue () const
 
auto getStep () const
 
virtual void setMin (float min)
 
virtual void setMax (float max)
 
virtual void setValue (float value)
 
virtual void setStep (float step)
 
- Public Member Functions inherited from Widget
 Widget (Type type=WIDGET)
 
 ~Widget () override
 
Type getType () const
 
bool isVisible () const
 
void setVisible (bool show=true)
 
bool isEnabled () const
 
void setEnabled (bool isEnabled=true)
 
virtual void setPos (float x, float y)
 
float getWidth () const
 
float getHeight () const
 
float getRequestedWidth () const
 
float getRequestedHeight () const
 
virtual void setSize (float width, float height)
 
void setWidth (const float width)
 
void setHeight (const float height)
 
const Rect & getRect () const
 
Rect getScreenRect () const
 
void setRect (float x, float y, float width, float height)
 
void setRect (const Rect &rect)
 
float getAspectRatio () const
 
Alignment getAlignment () const
 
void setAlignment (Alignment alignment)
 
void setLayoutDirection (TextDirection direction)
 
TextDirection getLayoutDirection () const
 
TextDirection getEffectiveLayoutDirection () const
 
std::shared_ptr< Font > getFont () const
 
void setFont (const std::shared_ptr< Font > &font)
 
float getFontScale () const
 
virtual void setFontScale (float fontScale)
 
bool isFocused () const
 
bool isFocusable () const
 
bool isTabStop () const
 
void setTabStop (const bool tabStop)
 
Widget * getParent () const
 
void setOverlap (const bool overlap)
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const std::string &resource, const Alignment alignment, Args &&...args)
 
template<typename T , typename... Args>
std::shared_ptr< T > create (const Alignment alignment, Args &&...args)
 
template<typename T >
std::shared_ptr< T > add (std::shared_ptr< T > child, const Alignment alignment=Alignment::NONE, const std::string &resource="", const bool overlap=false)
 
template<typename T >
std::shared_ptr< T > addPopup (std::shared_ptr< T > child, const std::string &resource="")
 
template<typename T >
std::shared_ptr< T > addAfter (std::shared_ptr< T > child, const std::shared_ptr< Widget > &after, const Alignment alignment, const std::string &resource="", const bool overlap=false)
 
virtual void remove (const std::shared_ptr< Widget > &child)
 
virtual void removeAll ()
 
void setPadding (float padding)
 
float getPadding () const
 
float getVBorder () const
 
float getHBorder () const
 
void setVBorder (float size)
 
void setHBorder (float size)
 
bool isDrawBackground () const
 
void setDrawBackground (bool drawBackground)
 
bool isPushed () const
 
bool isPointed () const
 
bool isFreezed () const
 
bool isRedrawOnMouseEvent () const
 
bool isOverlapping () const
 
Rect getChildrenRect () const
 
void setFreezed (const bool f)
 
void setPushed (const bool p)
 
void refresh ()
 
void setResource (std::shared_ptr< UIResource > res)
 
uint32 getGroupIndex () const
 
void setGroupIndex (int32 index)
 
template<typename T >
T getUserData () const
 
template<typename T >
std::shared_ptr< T > getPointerUserData () const
 
const std::any & getUserData () const
 
void setUserData (const std::any &data)
 
float getTransparency () const
 
void setTransparency (float alpha)
 
void resizeChildren ()
 
float getChildrenOffsetX () const
 
float getChildrenOffsetY () const
 
void setChildrenOffset (float x, float y)
 
std::shared_ptr< Widget > setFocus (bool focus=true)
 
virtual void onAttach ()
 
virtual void onDetach ()
 
virtual void onShow ()
 
virtual void onHide ()
 
virtual void onResize ()
 
virtual void onMove ()
 
virtual bool onKeyDown (Key key)
 
virtual bool onTextInput (const std::string &text)
 
virtual bool onKeyUp (Key key)
 
virtual bool onMouseDown (MouseButton button, float x, float y)
 
virtual bool onMouseUp (MouseButton button, float x, float y)
 
virtual bool onMouseMove (uint32 buttonsState, float x, float y)
 
virtual void onMouseLeave ()
 
virtual void onDisable ()
 
virtual void onEnable ()
 
virtual void onGotFocus ()
 
virtual void onLostFocus ()
 
bool getConsumeMouseEvent () const
 
void setConsumeMouseEvent (const bool consumeMouseEvent)
 
const std::list< std::shared_ptr< Widget > > & getChildren () const
 
bool hasChildren () const
 
void subscribe (const event_type &type, unique_id id, EventHandlerCallback callback)
 
void subscribe (const event_type &type, EventHandlerCallback callback)
 
void subscribe (const event_type &type, SignalHandlerCallback callback)
 
void unsubscribe (unique_id id)
 
virtual void eventAttach ()
 
virtual void eventDetach ()
 
virtual void eventShow ()
 
virtual void eventAspectRatioChanged ()
 
virtual void eventHide ()
 
virtual void eventEnable ()
 
virtual void eventDisable ()
 
virtual void eventMove (float x, float y)
 
virtual bool eventTextInput (const std::string &text)
 
virtual bool eventKeyDown (Key key)
 
virtual bool eventKeyUp (Key key)
 
virtual bool eventMouseDown (MouseButton button, float x, float y)
 
virtual bool eventMouseUp (MouseButton button, float x, float y)
 
virtual bool eventMouseMove (uint32 buttonsState, float x, float y)
 
virtual void eventMouseLeave ()
 
virtual void eventGotFocus ()
 
virtual void eventLostFocus ()
 
bool isAttached () const
 
Window & getWindow () const
 
Style & getStyle () const
 
Vector2DRenderer & getRenderer () const
 
RenderingWindow & getRenderingWindow () const
 
WindowManager & getWindowManager () const
 
bool isCustomDraw () const
 
virtual void draw (UIResource &resources, Vector2DRenderer &renderer, bool stage) const
 
void skipInvisibleChildren (const bool s)
 

Protected Member Functions

void eventResize () override
 
virtual void eventRangeChange ()
 
virtual void eventValueChange (float prev)
 

Protected Attributes

float min
 
float max
 
float value
 
float step
 
- Protected Attributes inherited from Widget
const Type type
 
Rect rect
 
float requestedWidth {0}
 
float requestedHeight {0}
 
float hborder {0}
 
float vborder {0}
 
float padding {0}
 
bool consumeMouseEvent {false}
 
bool overlap {false}
 
bool focused {false}
 
bool allowFocus {false}
 
bool tabStop {true}
 
bool allowChildren {true}
 
bool drawBackground {true}
 
bool moveChildrenOnPush {false}
 
bool scrollChildren {false}
 
bool skipInvisibleChildrenEnabled {false}
 
bool redrawOnMouseEvent {false}
 
bool redrawOnMouseMove {false}
 
bool customDraw {false}
 
float transparency {1.0f}
 
Widget * parent {nullptr}
 
Alignment alignment {Alignment::NONE}
 
TextDirection layoutDirection {TextDirection::AUTO}
 
std::shared_ptr< UIResource > resource
 
std::list< std::shared_ptr< Widget > > children
 
bool mouseMoveOnFocus {false}
 
float childrenOffsetX {0}
 
float childrenOffsetY {0}
 

Additional Inherited Members

- Public Types inherited from Widget
enum  Type {
  WIDGET, PANEL, BOX, LINE,
  FRAME, BUTTON, TOGGLEBUTTON, RADIOBUTTON,
  CHECKBOX, CHECKMARK, CROSSMARK, ARROW,
  TEXT, TEXTEDIT, RICHTEXTAREA, SCROLLBAR,
  SLIDER, RULER, COLORSLIDER, COLORWHEEL,
  KNOB, TREEVIEW, IMAGE, POPUP,
  LIST, LISTBOX, SELECTION, PROGRESSBAR,
  SCROLLCONTAINER, MENU, MENUPANEL, MENUBOX,
  TABBAR, TABCONTAINER, DIALOG, FOLDABLECONTAINER,
  COLORPICKER, COLORPICKERBUTTON, SPINBOX, SPINBUTTONS,
  ICONIMAGE, ICONSVG, DROPDOWNLIST, TOOLTIP,
  GRIDCELL, GRID, TABLE, RADIALPIEMENU,
  NUMBEREDIT
}
 

Constructor & Destructor Documentation

ValueSelect ( Type  type,
float  min,
float  max,
float  value,
float  step 
)

Constructor.

Parameters
typeThe widget type.
minMinimum value.
maxMaximum value.
valueInitial value.
stepStep increment.

Member Function Documentation

void eventResize ( )
overrideprotectedvirtual

Raw resize event, see onResize

Reimplemented from lysa::ui::Widget::eventResize()

virtual void eventValueChange ( float  prev)
protectedvirtual
auto getMax ( ) const
inline

Returns the maximum value.

auto getMin ( ) const
inline

Returns the minimum value.

auto getStep ( ) const
inline

Returns the step increment.

auto getValue ( ) const
inline

Returns the current value.

virtual void setMax ( float  max)
virtual

Sets the maximum value.

virtual void setMin ( float  min)
virtual

Sets the minimum value.

virtual void setStep ( float  step)
virtual

Sets the step increment.

virtual void setValue ( float  value)
virtual

Sets the current value.

Reimplemented in lysa::ui::Ruler::setValue()

Member Data Documentation

float max
protected
float min
protected
float step
protected
float value
protected