Lysa UI  0.0
Lysa UI —UI components for the Lysa Engine
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
List Class Referenceabstract

Detailed Description

Super class for all list-of-widgets based widgets.

+ Inheritance diagram for List:

Public Member Functions

 List (Type type)
 
virtual int32 addItem (const std::shared_ptr< Widget > &item, Alignment alignment=Alignment::LEFT, const std::string &resource="")
 
virtual void removeItem (int32 index)
 
virtual void removeAllItems ()
 
std::shared_ptr< Widget > getItem (int32 index) const
 
int32 getCount () const
 
int32 getSelectedIndex () const
 
std::shared_ptr< Widget > getSelectedItem () const
 
void select (int32 index)
 
const std::list< std::shared_ptr< Widget > > & getItems () 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
 
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)
 
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
 
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 unsubscribe (unique_id id)
 
bool isAttached () const
 
Window & getWindow () const
 
Style & getStyle () const
 
Vector2DRenderer & getRenderer () const
 
RenderingWindow & getRenderingWindow () const
 
WindowManager & getWindowManager () const
 

Static Public Attributes

static constexpr int32 NO_SELECTION {-1}
 Value returned by getSelectedIndex() when nothing is selected. More...
 

Protected Member Functions

virtual void computeSizes () = 0
 
virtual void eventSelectItem (int32 index)
 

Protected Attributes

int32 prevSelected {NO_SELECTION}
 
std::list< std::shared_ptr< Widget > > items
 
- 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 allowChildren {true}
 
bool drawBackground {true}
 
bool moveChildrenOnPush {false}
 
bool scrollChildren {false}
 
bool skipInvisibleChildren {false}
 
bool redrawOnMouseEvent {false}
 
bool redrawOnMouseMove {false}
 
float transparency {1.0f}
 
Widget * parent {nullptr}
 
Alignment alignment {Alignment::NONE}
 
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, 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
}
 

Constructor & Destructor Documentation

List ( Type  type)

Creates a List widget of the given type.

Parameters
typeThe concrete widget type (used by subclasses).

Member Function Documentation

virtual int32 addItem ( const std::shared_ptr< Widget > &  item,
Alignment  alignment = Alignment::LEFT,
const std::string &  resource = "" 
)
virtual

Adds a widget at the end of the list.

Parameters
itemWidget to add.
alignmentPlacement alignment.
resourceResource string.
Returns
The index (0-based) of the inserted item.

Reimplemented in lysa::ui::ListBox::addItem()

virtual void computeSizes ( )
protectedpure virtual

Implemented in lysa::ui::ListBox::computeSizes()

virtual void eventSelectItem ( int32  index)
protectedvirtual

Reimplemented in lysa::ui::ListBox::eventSelectItem()

int32 getCount ( ) const

Returns the number of items in the list.

std::shared_ptr<Widget> getItem ( int32  index) const

Returns the widget at the given index.

const std::list<std::shared_ptr<Widget> >& getItems ( ) const
inline

Returns the list of item widgets.

int32 getSelectedIndex ( ) const
inline

Returns the index of the selected item, or NO_SELECTION.

std::shared_ptr<Widget> getSelectedItem ( ) const

Returns the selected widget, or nullptr.

virtual void removeAllItems ( )
virtual

Removes all items.

virtual void removeItem ( int32  index)
virtual

Removes the item at the given index.

Reimplemented in lysa::ui::ListBox::removeItem()

void select ( int32  index)

Selects an item by index. Pass NO_SELECTION to clear the selection.

Member Data Documentation

std::list<std::shared_ptr<Widget> > items
protected
constexpr int32 NO_SELECTION {-1}
staticconstexpr

Value returned by getSelectedIndex() when nothing is selected.

int32 prevSelected {NO_SELECTION}
protected