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

Detailed Description

Numeric TextEdit for float and double values

+ Inheritance diagram for NumberEdit:

Public Member Functions

 NumberEdit (double value=0.0)
 
double getValue () const
 
float getFloatValue () const
 
void setValue (double value)
 
uint32 getPrecision () const
 
void setPrecision (uint32 digits)
 
const std::string & getSuffix () const
 
void setSuffix (const std::string &suffix)
 
bool commit ()
 
- Public Member Functions inherited from TextEdit
 TextEdit (const std::string &text="", bool clearButton=false)
 
auto hasClearButton () const
 
auto isReadOnly () const
 
void setReadOnly (const bool state)
 
void setText (const std::string &text)
 
void setCaretPosition (uint32 start)
 
void setCaretAtEnd ()
 
auto getText () const
 
auto getCaretPosition () const
 
auto hasSelection () const
 
auto getSelectionStart () const
 
auto getSelectionEnd () const
 
std::string getSelectedText () const
 
auto getFirstDisplayedChar () const
 
auto getDisplayedText () const
 
auto getTextBox () const
 
void setResources (const std::string &resource)
 
void selectAll ()
 
float getCaretX () const
 
std::vector< Rect > getSelectionRects () const
 
- 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 eventKeyUp (Key key)
 
virtual void eventMouseLeave ()
 
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)
 

Static Public Member Functions

static std::optional< double > parseNumber (std::string_view text)
 

Protected Member Functions

bool eventTextInput (const std::string &text) override
 
bool eventKeyDown (Key key) override
 
void eventGotFocus () override
 
void eventLostFocus () override
 
- Protected Member Functions inherited from TextEdit
 TextEdit (Type type, const std::string &text, bool clearButton)
 
bool eventKeyDown (Key key) override
 
bool eventTextInput (const std::string &newText) override
 
bool eventMouseDown (MouseButton button, float x, float y) override
 
bool eventMouseMove (uint32 buttonsState, float x, float y) override
 
bool eventMouseUp (MouseButton button, float x, float y) override
 
void eventLostFocus () override
 
void eventResize () override
 
void computeNDispChar ()
 
void syncDisplay ()
 
float textOriginX () const
 
void moveCaretVisually (bool right)
 
void insertText (const std::string &newText)
 
void deleteSelection ()
 
void refreshSelection ()
 
uint32 characterIndexAt (float x) const
 

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
}
 
- Protected Attributes inherited from TextEdit
std::string text
 
bool readonly {false}
 
uint32 selStart {0}
 
uint32 selAnchor {0}
 
uint32 startPos {0}
 
uint32 nDispChar {0}
 
bool selecting {false}
 
bool clearButton {false}
 
std::shared_ptr< Box > box
 
std::shared_ptr< Text > textBox
 
std::shared_ptr< CrossMark > crossMark
 
- 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}
 

Constructor & Destructor Documentation

NumberEdit ( double  value = 0.0)
explicit

Member Function Documentation

bool commit ( )

Commits valid text

void eventGotFocus ( )
overrideprotectedvirtual

Raw focus event, see onGotFocus

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

bool eventKeyDown ( Key  key)
overrideprotectedvirtual

Raw key down event, see onKeyDown

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

void eventLostFocus ( )
overrideprotectedvirtual

Raw focus event, see onLostFocus

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

bool eventTextInput ( const std::string &  text)
overrideprotectedvirtual

Raw text input event, see onTextInput

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

float getFloatValue ( ) const
uint32 getPrecision ( ) const
inline

Returns the significant digits used outside editing

const std::string& getSuffix ( ) const
inline

Returns the display suffix omitted while editing.

double getValue ( ) const
inline
static std::optional<double> parseNumber ( std::string_view  text)
static
void setPrecision ( uint32  digits)

Sets significant digits in [1, double::max_digits10] without rounding the stored value.

void setSuffix ( const std::string &  suffix)

Sets an optional display suffix such as " m" or "°".

void setValue ( double  value)