Detailed Description

A scrollable list of widgets

Inheritance diagram for ListBox:

Public Member Functions
	ListBox ()

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

void	removeItem (int32 index) override

void	setResources (const std::string &resBox, const std::string &resScroll, const std::string &resSel)

auto	getSelectionWidget () const

auto	getVScrollBar () const

Public Member Functions inherited from List
	List (Type type)

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 auto	WHEEL_ITEMS {3}
	Number of items scrolled by one mouse wheel notch. More...

Static Public Attributes inherited from List
static constexpr int32	NO_SELECTION {-1}
	Value returned by getSelectedIndex() when nothing is selected. More...

Protected Member Functions
void	computeSizes () override

void	eventSelectItem (int32 index) override

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 }

Protected Attributes inherited from List
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}

Constructor & Destructor Documentation

ListBox ( )

Member Function Documentation

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

overridevirtual

Adds a widget at the end of the list.

Parameters

item	Widget to add.
alignment	Placement alignment.
resource	Resource string.

Returns: The index (0-based) of the inserted item.

Reimplemented from lysa::ui::List::addItem()

void computeSizes ( )

overrideprotectedvirtual

Implements lysa::ui::List::computeSizes()

void eventSelectItem ( int32 index )

overrideprotectedvirtual

Reimplemented from lysa::ui::List::eventSelectItem()

auto getSelectionWidget ( ) const

inline

Returns the internal selection highlight widget.

auto getVScrollBar ( ) const

inline

Returns the internal vertical scroll bar.

void removeItem ( int32 index )

overridevirtual

Removes the item at the given index and updates the scroll range.

Reimplemented from lysa::ui::List::removeItem()

void setResources	(	const std::string &	resBox,
		const std::string &	resScroll,
		const std::string &	resSel
	)

Sets the UI resources for the list box.

Parameters

resBox	Resource for the inner background box.
resScroll	Resource for the vertical scroll bar.
resSel	Resource for the selection highlight.

Member Data Documentation

constexpr auto WHEEL_ITEMS {3}

staticconstexpr

Number of items scrolled by one mouse wheel notch.

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation