#include <PickList.h>

Inheritance diagram for HoverRace::Display::BasePickList:

Public Types
enum	Mode { Mode::RADIO, Mode::LIST }

using	valueChangedSignal_t = boost::signals2::signal< void()>

Public Types inherited from HoverRace::Display::UiViewModel
enum	Alignment { Alignment::NW, Alignment::N, Alignment::NE, Alignment::E, Alignment::SE, Alignment::S, Alignment::SW, Alignment::W, Alignment::CENTER }
	Imagine the component pinned to the container with a thumbtack. More...

using	focusRelinquishedSignal_t = boost::signals2::signal< void(UiViewModel &, const Control::Nav &)>

using	focusRequestedSignal_t = boost::signals2::signal< void(UiViewModel &)>

Public Member Functions
	BasePickList (Display &display, const Vec2 &size, uiLayoutFlags_t layoutFlags=0)

virtual	~BasePickList ()

void	ClearSelection ()
	If an item is selected, unset the selection so that nothing is selected. More...

void	DropFocus () override
	Force this widget to give up focus, if it is currently focused. More...

valueChangedSignal_t &	GetValueChangedSignal ()

bool	HasSelected () const
	Check if this list has a selected item. More...

bool	OnAction () override

bool	OnMouseScrolled (const Control::Mouse::Scroll &) override

bool	OnNavigate (const Control::Nav &nav) override

void	SetIndex (size_t idx)
	Select an item by index. More...

bool	TryFocus (const Control::Nav &nav=Control::Nav::NEUTRAL) override
	Attempts to give this widget focus. More...

Public Member Functions inherited from HoverRace::Display::BaseContainer
	BaseContainer (Display &display, uiLayoutFlags_t layoutFlags=0)
	Constructor for an unsized container without clipping. More...

	BaseContainer (Display &display, const Vec2 &size, bool clip=true, uiLayoutFlags_t layoutFlags=0)
	Constructor for a sized container. More...

virtual	~BaseContainer ()

void	AttachView (Display &disp) override

template<class Fn >
void	ForEachChild (Fn fn) const
	Iterate over each child widget. More...

template<class Fn >
void	ForEachVisibleChild (Fn fn) const
	Iterate over each visible child widget. More...

const Vec2 &	GetChildOffset () const
	Retrieve the offset to the position of the child widgets. More...

double	GetOpacity () const
	Retrieve the opacity. More...

const Vec2 &	GetSize () const
	Retrieve the size of the container. More...

bool	IsClip () const
	Check if child elements are clipped to the container bounds. More...

bool	IsEmpty () const
	Check if this container is devoid of child widgets. More...

bool	IsVisible () const
	Check if the children of this container are shown. More...

Vec3	Measure () override
	Calculate the size of the component. More...

bool	OnMouseMoved (const Vec2 &pos) override

bool	OnMousePressed (const Control::Mouse::Click &click) override

bool	OnMouseReleased (const Control::Mouse::Click &click) override

void	SetClip (bool clip)
	Set whether child elements are clipped to the container bounds. More...

void	SetOpacity (double opacity)
	Set the opacity of the container. More...

void	SetSize (const Vec2 &size)
	Set the size of the container. More...

void	SetSize (double w, double h)
	Convenience function for SetSize(const Vec2&). More...

void	SetVisible (bool visible)
	Sets whether the widgets in this container are visible. More...

void	ShrinkWrap ()
	Resize the container to the minimum size that will fit all of the child elements. More...

Public Member Functions inherited from HoverRace::Display::UiViewModel
	UiViewModel (uiLayoutFlags_t layoutFlags=0)

virtual	~UiViewModel ()

Vec2	GetAlignedPos (const Vec2 &pos, double w, double h) const
	Retrieve an arbitrary position adjusted by the current alignment. More...

Vec2	GetAlignedPos (double w, double h) const
	Retrieve the position adjusted by the current alignment. More...

Alignment	GetAlignment () const
	Retrieve the alignment of the component. More...

focusRelinquishedSignal_t &	GetFocusRelinquishedSignal ()

focusRequestedSignal_t &	GetFocusRequestedSignal ()

uiLayoutFlags_t	GetLayoutFlags () const
	Retrieve the layout flags. More...

const Vec2 &	GetPos () const
	Get the position of the component. More...

const Vec2 &	GetTranslation () const
	Retrieves the position translation. More...

bool	IsFocused () const
	Check if this widget currently has input focus. More...

uiLayoutFlags_t	IsLayoutFloating () const

uiLayoutFlags_t	IsLayoutUnscaled () const

void	RequestFocus ()
	Attempt to hand over the input focus to this widget. More...

void	SetAlignment (Alignment alignment)
	Set the alignment of the component. More...

void	SetPos (const Vec2 &pos)
	Set the position of the component. More...

void	SetPos (double x, double y)
	Convenience function for SetPos(const Vec2&). More...

void	SetTranslation (const Vec2 &translation)
	Sets the position translation. More...

void	SetTranslation (double x, double y)
	Convenience function for SetTranslation(const Vec2&). More...

Public Member Functions inherited from HoverRace::Display::ViewModel
	ViewModel ()

virtual	~ViewModel ()

View *	GetView () const

void	PrepareRender ()

void	Render ()

void	SetView (std::unique_ptr< View > &&view)

Protected Member Functions
virtual boost::optional< size_t >	FindChildIndex (const UiViewModel &child) const =0
	Search for the index of the given child widget. More...

virtual UiViewModel *	GetFocusedChild () const =0
	Get the focused child widget. More...

double	GetScroll () const
	Retrieve how far down the list we have scrolled. More...

void	Layout () override
	Adjust the size and position of any child elements. More...

void	OnChildRelinquishedFocus (UiViewModel &, const Control::Nav &nav) override
	Called when a child widget passes input focus to another widget. More...

void	OnChildRequestedFocus (UiViewModel &child) override
	Called when a child widget requests input focus. More...

void	ScrollTo (double y)
	Scroll the list to the specified UI-space position. More...

void	ScrollToFocused ()
	Scroll the list to ensure the focused item is visible. More...

virtual void	SetSelection (const boost::optional< size_t > &newSel)=0
	Set the selected item by index. More...

Protected Member Functions inherited from HoverRace::Display::BaseContainer
virtual void	Clear ()
	Remove all child elements. More...

children_t &	GetChildren ()

template<class T , class... Args>
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	NewChild (Args &&...args)
	Create and append a new child widget to the end of the list. More...

template<typename T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	RemoveChild (const std::shared_ptr< T > &child)
	Remove a child element. More...

template<class T >
std::enable_if< std::is_base_of< UiViewModel, T >::value, std::shared_ptr< T > >::type	ReorderChild (const std::shared_ptr< T > &child, size_t idx)
	Move a widget to a different position in the list. More...

virtual void	Reserve (size_t capacity)
	Increase the capacity of the of this container. More...

void	SetChildOffset (const Vec2 &offset)
	Sets the position offset of child widgets. More...

bool	TestHit (const Vec2 &pos)
	Check if the coordinates of an event are within the bounds of this component. More...

Protected Member Functions inherited from HoverRace::Display::UiViewModel
void	RelinquishFocus (const Control::Nav &nav)
	Voluntarily give up input focus, passing it on to the next widget. More...

void	SetFocused (bool focused)
	Set the focused state. More...

Protected Member Functions inherited from HoverRace::Display::ViewModel
template<class T >
void	AttachViewDynamic (Display &disp, T *self)

virtual void	FireModelUpdate (int prop)
	Indicate that a model property has changed. More...

void	RequestLayout ()
	Indicate that the current layout is out-of-date and needs to be adjusted. More...

Protected Attributes
std::vector< size_t >	filteredItems
	Indexes of filtered items. More...

boost::optional< size_t >	focusedItem
	filteredItems index of focused. More...

double	listHeight

boost::optional< size_t >	selItem
	items index of selected. More...

valueChangedSignal_t	valueChangedSignal

Protected Attributes inherited from HoverRace::Display::BaseContainer
Display &	display

Private Types
using	SUPER = BaseContainer

Additional Inherited Members
Protected Types inherited from HoverRace::Display::BaseContainer
using	children_t = std::vector< std::unique_ptr< Child >>

Detailed Description

Generic base for PickList.

Author: Michael

Member Typedef Documentation

using HoverRace::Display::BasePickList::SUPER = BaseContainer

private

using HoverRace::Display::BasePickList::valueChangedSignal_t = boost::signals2::signal<void()>

Member Enumeration Documentation

enum HoverRace::Display::BasePickList::Mode

strong

Enumerator
RADIO	List of radio buttons (default).
LIST	Plain list, no icons.

Constructor & Destructor Documentation

HoverRace::Display::BasePickList::BasePickList	(	Display &	display,
		const Vec2 &	size,
		uiLayoutFlags_t	layoutFlags = `0`
	)

virtual HoverRace::Display::BasePickList::~BasePickList ( )

inlinevirtual

Member Function Documentation

void HoverRace::Display::BasePickList::ClearSelection ( )

inline

If an item is selected, unset the selection so that nothing is selected.

void HoverRace::Display::BasePickList::DropFocus ( )

overridevirtual

Force this widget to give up focus, if it is currently focused.

This is called by the parent container if focus is shifting away to another widget.

Reimplemented from HoverRace::Display::UiViewModel.

virtual boost::optional<size_t> HoverRace::Display::BasePickList::FindChildIndex ( const UiViewModel & child ) const

protectedpure virtual

Search for the index of the given child widget.

Parameters

child The child widget.

Returns: The found child index, if the widget was found.

Implemented in HoverRace::Display::PickList< T >.

virtual UiViewModel* HoverRace::Display::BasePickList::GetFocusedChild ( ) const

protectedpure virtual

Get the focused child widget.

Returns: The focused child, or nullptr if nothing is focused.

Implemented in HoverRace::Display::PickList< T >.

double HoverRace::Display::BasePickList::GetScroll ( ) const

inlineprotected

Retrieve how far down the list we have scrolled.

Returns: The position (always greater than or equal to zero).

valueChangedSignal_t& HoverRace::Display::BasePickList::GetValueChangedSignal ( )

inline

bool HoverRace::Display::BasePickList::HasSelected ( ) const

inline

Check if this list has a selected item.

Returns: true if an item is selected, false if not.

void HoverRace::Display::BasePickList::Layout ( )

overrideprotectedvirtual

Adjust the size and position of any child elements.

Subclasses with child elements should override this function.

This is called automatically during the PrepareRender() phase if RequestLayout() has been called. It is also called the first time PrepareRender() is invoked. After this function is called, it will not be called again until another call to RequestLayout().

Reimplemented from HoverRace::Display::ViewModel.

bool HoverRace::Display::BasePickList::OnAction ( )

overridevirtual

Reimplemented from HoverRace::Display::UiViewModel.

void HoverRace::Display::BasePickList::OnChildRelinquishedFocus	(	UiViewModel &	child,
		const Control::Nav &	nav
	)

overrideprotectedvirtual

Called when a child widget passes input focus to another widget.

Parameters

child	The child widget.
nav	The navigation direction.

Reimplemented from HoverRace::Display::BaseContainer.

void HoverRace::Display::BasePickList::OnChildRequestedFocus ( UiViewModel & child )

overrideprotectedvirtual

Called when a child widget requests input focus.

Parameters

child The child widget.

Reimplemented from HoverRace::Display::BaseContainer.

bool HoverRace::Display::BasePickList::OnMouseScrolled ( const Control::Mouse::Scroll & scroll )

overridevirtual

Reimplemented from HoverRace::Display::BaseContainer.

bool HoverRace::Display::BasePickList::OnNavigate ( const Control::Nav & nav )

overridevirtual

Reimplemented from HoverRace::Display::UiViewModel.

void HoverRace::Display::BasePickList::ScrollTo ( double y )

protected

Scroll the list to the specified UI-space position.

Parameters

y	The position (positive values scroll down the list).

void HoverRace::Display::BasePickList::ScrollToFocused ( )

protected

Scroll the list to ensure the focused item is visible.

void HoverRace::Display::BasePickList::SetIndex ( size_t idx )

inline

Select an item by index.

If idx is out of range of the current list, then nothing will be selected.

Parameters

idx	The index of the current (filtered) list.

virtual void HoverRace::Display::BasePickList::SetSelection ( const boost::optional< size_t > & newSel )

protectedpure virtual

Set the selected item by index.

The implementation should update the child widget state and trigger the valueChanged signal.

Parameters

newSel The new selected index.

Implemented in HoverRace::Display::PickList< T >.

bool HoverRace::Display::BasePickList::TryFocus ( const Control::Nav & nav = Control::Nav::NEUTRAL )

overridevirtual

Attempts to give this widget focus.

Subclasses should override this with logic to determine if the widget is focusable.

This is called by the parent container if focus has been requested.

Parameters

nav	The direction in which the focus is heading.

Returns: true if it succeeds (widget is now focused), false if it fails (widget did not take focus).

Reimplemented from HoverRace::Display::UiViewModel.

Member Data Documentation

std::vector<size_t> HoverRace::Display::BasePickList::filteredItems

protected

Indexes of filtered items.

boost::optional<size_t> HoverRace::Display::BasePickList::focusedItem

protected

filteredItems index of focused.

double HoverRace::Display::BasePickList::listHeight

protected

boost::optional<size_t> HoverRace::Display::BasePickList::selItem

protected

items index of selected.

valueChangedSignal_t HoverRace::Display::BasePickList::valueChangedSignal

protected

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation