Represents a menu. More...

#include <elm_Menu.hpp>

Inheritance diagram for pu::ui::elm::Menu:

Public Types
using	OnSelectionChangedCallback = std::function<void()>
	Represents a function called when the selection of the Menu changes.

Public Member Functions
	Menu (const i32 x, const i32 y, const i32 width, const Color items_clr, const Color items_focus_clr, const i32 items_height, const u32 items_to_show)
	Creates a new instance of a Menu.

i32	GetX () override
	Gets the X position of the Element.

void	SetX (const i32 x)
	Sets the X position of the Menu.

i32	GetY () override
	Gets the Y position of the Element.

void	SetY (const i32 y)
	Sets the Y position of the Menu.

i32	GetWidth () override
	Gets the width of the Element.

void	SetWidth (const i32 width)
	Sets the width of the Menu.

i32	GetHeight () override
	Gets the height of the Element.

void	SetOnSelectionChanged (OnSelectionChangedCallback on_selection_changed_cb)
	Sets the font name to use for the Menu.

void	AddItem (MenuItem::Ref &item)
	Adds a new item to the Menu.

void	ClearItems ()
	Clears all items from the Menu.

void	ForceReloadItems ()
	Forces the Menu to reload all items.

MenuItem::Ref &	GetSelectedItem ()
	Gets the selected item of the Menu.

std::vector< MenuItem::Ref > &	GetItems ()
	Gets the items of the Menu.

void	SetSelectedIndex (const u32 idx)
	Sets the selected index of the Menu.

void	OnRender (render::Renderer::Ref &drawer, const i32 x, const i32 y) override
	Renders the Element on the screen.

void	OnInput (const u64 keys_down, const u64 keys_up, const u64 keys_held, const TouchPoint touch_pos) override
	Called before rendering the Element in order to handle input.

Public Member Functions inherited from pu::ui::elm::Element
	Element ()
	Creates a new instance of an Element.

virtual	~Element ()

bool	IsVisible ()
	Gets whether the Element is visible.

void	SetVisible (const bool visible)
	Sets whether the Element is visible.

void	SetHorizontalAlign (const HorizontalAlign align)
	Sets the horizontal alignment of the Element.

HorizontalAlign	GetHorizontalAlign ()
	Gets the horizontal alignment of the Element.

void	SetVerticalAlign (const VerticalAlign align)
	Sets the vertical alignment of the Element.

VerticalAlign	GetVerticalAlign ()
	Gets the vertical alignment of the Element.

void	SetParentContainer (Container *parent_container)
	Sets the parent Container of the Element.

i32	GetProcessedX ()
	Gets the actual X position of the Element, considering the parent Container (depends on alignment).

i32	GetProcessedY ()
	Gets the actual Y position of the Element, considering the parent Container (depends on alignment).

Static Public Attributes
static constexpr Color	DefaultScrollbarColor = { 110, 110, 110, 0xFF }

static constexpr u8	DefaultItemAlphaIncrementSteps = 15

static constexpr float	DefaultIconItemSizesFactor = 0.8f

static constexpr u32	DefaultIconMargin = 37

static constexpr u32	DefaultTextMargin = 37

static constexpr u8	DefaultLightScrollbarColorFactor = 30

static constexpr u32	DefaultScrollbarWidth = 30

static constexpr u32	DefaultShadowHeight = 7

static constexpr u8	DefaultShadowBaseAlpha = 160

static constexpr s64	DefaultMoveWaitTimeMs = 150

Additional Inherited Members
Protected Attributes inherited from pu::ui::elm::Element
bool	visible

HorizontalAlign	h_align

VerticalAlign	v_align

Container *	parent_container

Detailed Description

Represents a menu.

Member Typedef Documentation

◆ OnSelectionChangedCallback

using pu::ui::elm::Menu::OnSelectionChangedCallback = std::function<void()>

Represents a function called when the selection of the Menu changes.

Constructor & Destructor Documentation

◆ Menu()

pu::ui::elm::Menu::Menu	(	const i32	x,
		const i32	y,
		const i32	width,
		const Color	items_clr,
		const Color	items_focus_clr,
		const i32	items_height,
		const u32	items_to_show )

Creates a new instance of a Menu.

Parameters

x	X position of the Menu.
y	Y position of the Menu.
width	Width of the Menu.
items_clr	Color of the items in the Menu.
items_focus_clr	Color of the focused item in the Menu.
items_height	Height of each shown item in the Menu.
items_to_show	Number of items to show in the Menu.

Member Function Documentation

◆ AddItem()

void pu::ui::elm::Menu::AddItem ( MenuItem::Ref & item )

inline

Adds a new item to the Menu.

Parameters

item	Item to add.

◆ ClearItems()

void pu::ui::elm::Menu::ClearItems ( )

Clears all items from the Menu.

◆ ForceReloadItems()

void pu::ui::elm::Menu::ForceReloadItems ( )

inline

Forces the Menu to reload all items.

◆ GetHeight()

i32 pu::ui::elm::Menu::GetHeight ( )

inlineoverridevirtual

Gets the height of the Element.

Returns: Height of the Element.

Implements pu::ui::elm::Element.

◆ GetItems()

std::vector< MenuItem::Ref > & pu::ui::elm::Menu::GetItems ( )

inline

Gets the items of the Menu.

Returns: Items of the Menu.

◆ GetSelectedItem()

MenuItem::Ref & pu::ui::elm::Menu::GetSelectedItem ( )

inline

Gets the selected item of the Menu.

Returns: Selected item of the Menu.

◆ GetWidth()

i32 pu::ui::elm::Menu::GetWidth ( )

inlineoverridevirtual

Gets the width of the Element.

Returns: Width of the Element.

Implements pu::ui::elm::Element.

◆ GetX()

i32 pu::ui::elm::Menu::GetX ( )

inlineoverridevirtual

Gets the X position of the Element.

Returns: X position of the Element.

Implements pu::ui::elm::Element.

◆ GetY()

i32 pu::ui::elm::Menu::GetY ( )

inlineoverridevirtual

Gets the Y position of the Element.

Returns: Y position of the Element.

Implements pu::ui::elm::Element.

◆ OnInput()

void pu::ui::elm::Menu::OnInput	(	const u64	keys_down,
		const u64	keys_up,
		const u64	keys_held,
		const TouchPoint	touch_pos )

overridevirtual

Called before rendering the Element in order to handle input.

Parameters

keys_down	Keys that are currently being pressed.
keys_up	Keys that are currently being released.
keys_held	Keys that are currently held.
touch_pos	Position of the touch on the screen.

Note: This method is called by the Application. It should not be called manually.

Implements pu::ui::elm::Element.

◆ OnRender()

void pu::ui::elm::Menu::OnRender	(	render::Renderer::Ref &	drawer,
		const i32	x,
		const i32	y )

overridevirtual

Renders the Element on the screen.

Parameters

drawer	Renderer to use for rendering.
x	X position to render the Element.
y	Y position to render the Element.

Note: This method is called by the Application. It should not be called manually.

Implements pu::ui::elm::Element.

◆ SetOnSelectionChanged()

void pu::ui::elm::Menu::SetOnSelectionChanged ( OnSelectionChangedCallback on_selection_changed_cb )

inline

Sets the font name to use for the Menu.

Parameters

font_name Name of the font to use.

◆ SetSelectedIndex()

void pu::ui::elm::Menu::SetSelectedIndex ( const u32 idx )

Sets the selected index of the Menu.

Parameters

idx	Index to set.

◆ SetWidth()

void pu::ui::elm::Menu::SetWidth ( const i32 width )

inline

Sets the width of the Menu.

Parameters

width New width.

◆ SetX()

void pu::ui::elm::Menu::SetX ( const i32 x )

inline

Sets the X position of the Menu.

Parameters

x	New X position.

◆ SetY()

void pu::ui::elm::Menu::SetY ( const i32 y )

inline

Sets the Y position of the Menu.

Parameters

y	New Y position.

Member Data Documentation

◆ DefaultIconItemSizesFactor

float pu::ui::elm::Menu::DefaultIconItemSizesFactor = 0.8f

staticconstexpr

◆ DefaultIconMargin

u32 pu::ui::elm::Menu::DefaultIconMargin = 37

staticconstexpr

◆ DefaultItemAlphaIncrementSteps

u8 pu::ui::elm::Menu::DefaultItemAlphaIncrementSteps = 15

staticconstexpr

◆ DefaultLightScrollbarColorFactor

u8 pu::ui::elm::Menu::DefaultLightScrollbarColorFactor = 30

staticconstexpr

◆ DefaultMoveWaitTimeMs

s64 pu::ui::elm::Menu::DefaultMoveWaitTimeMs = 150

staticconstexpr

◆ DefaultScrollbarColor

Color pu::ui::elm::Menu::DefaultScrollbarColor = { 110, 110, 110, 0xFF }

staticconstexpr

◆ DefaultScrollbarWidth

u32 pu::ui::elm::Menu::DefaultScrollbarWidth = 30

staticconstexpr

◆ DefaultShadowBaseAlpha

u8 pu::ui::elm::Menu::DefaultShadowBaseAlpha = 160

staticconstexpr

◆ DefaultShadowHeight

u32 pu::ui::elm::Menu::DefaultShadowHeight = 7

staticconstexpr

◆ DefaultTextMargin

u32 pu::ui::elm::Menu::DefaultTextMargin = 37

staticconstexpr

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

Plutonium/include/pu/ui/elm/elm_Menu.hpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ OnSelectionChangedCallback

Constructor & Destructor Documentation

◆ Menu()

Member Function Documentation

◆ AddItem()

◆ ClearItems()

◆ ForceReloadItems()

◆ GetHeight()

◆ GetItems()

◆ GetSelectedItem()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ OnInput()

◆ OnRender()

◆ SetOnSelectionChanged()

◆ SetSelectedIndex()

◆ SetWidth()

◆ SetX()

◆ SetY()

Member Data Documentation

◆ DefaultIconItemSizesFactor

◆ DefaultIconMargin

◆ DefaultItemAlphaIncrementSteps

◆ DefaultLightScrollbarColorFactor

◆ DefaultMoveWaitTimeMs

◆ DefaultScrollbarColor

◆ DefaultScrollbarWidth

◆ DefaultShadowBaseAlpha

◆ DefaultShadowHeight

◆ DefaultTextMargin