A single row in a List with start, content and end slots. More...

#include <Malena/Graphics/Controls/ListItem.h>

Inheritance diagram for ml::ListItem:

Public Types
using	Flag = ListItemManifest::Flag
using	State = ListItemManifest::State

Public Member Functions
	ListItem (const sf::Font &font=FontManager<>::getDefault())
ListItemTheme &	applyFrom (const Theme &t) override
	Populate all fields from the global `Theme` token set.
template<typename S>
void	applySettings (const S &s)
template<typename St>
void	applyStyle (const St &s)
template<typename T>
void	applyTheme (const T &t)
sf::Color	getBgDisabled () const
sf::Color	getBgHover () const
sf::Color	getBgIdle () const
std::string	getDescription () const
sf::Color	getDisabledColor () const
sf::Color	getDisabledTextColor () const
sf::Color	getDividerColor () const
float	getDividerThickness () const
sf::Color	getErrorColor () const
sf::Color	getFillColor () const
sf::Color	getFocusColor () const
const sf::Font *	getFont () const
unsigned int	getFontSize () const
unsigned int	getFontSizeSmall () const
sf::FloatRect	getGlobalBounds () const override
sf::Color	getHoverColor () const
std::string	getLabel () const
sf::Color	getMutedColor () const
sf::Color	getOutlineColor () const
float	getOutlineThickness () const
float	getPadding () const
sf::Vector2f	getPosition () const override
float	getRadius () const
float	getRowHeight () const
float	getSlotGap () const
sf::Color	getTextColor () const
float	getWidth () const
bool	isEnabled () const
bool	isSettingsLocked () const
	Return `true` if `applySettings()` is currently blocked.
bool	isThemeLocked () const
	Return `true` if this component ignores theme changes.
void	lockSettings ()
	Prevent `applySettings()` from taking effect.
void	lockTheme ()
	Prevent automatic re-styling when the global theme changes.
void	onClick (std::function< void()> callback)
	Register a callback fired when the row is clicked.
void	setBgDisabled (const sf::Color &c)
void	setBgHover (const sf::Color &c)
void	setBgIdle (const sf::Color &c)
void	setContent (ml::Core &component)
	Replace the built-in label/description with a custom component.
void	setDescription (const std::string &text)
	Set an optional secondary description line below the label. Pass an empty string to remove.
void	setDisabledColor (const sf::Color &c)
void	setDisabledTextColor (const sf::Color &c)
void	setDividerColor (const sf::Color &c)
void	setDividerThickness (float t)
void	setEnabled (bool enabled)
void	setEnd (ml::Core &component)
	Assign a component to the end (right) slot.
void	setErrorColor (const sf::Color &c)
void	setFillColor (const sf::Color &c)
void	setFocusColor (const sf::Color &c)
void	setFont (const sf::Font &&)=delete
void	setFont (const sf::Font &f)
void	setFontSize (unsigned int s)
void	setFontSizeSmall (unsigned int s)
void	setHoverColor (const sf::Color &c)
void	setLabel (const std::string &text)
	Set the primary label text.
void	setMutedColor (const sf::Color &c)
void	setOutlineColor (const sf::Color &c)
void	setOutlineThickness (float t)
void	setPadding (float p)
void	setPosition (const sf::Vector2f &position) override
void	setRadius (float r)
void	setRowHeight (float h)
void	setSlotGap (float g)
void	setStart (ml::Core &component)
	Assign a component to the start (left) slot.
void	setTextColor (const sf::Color &c)
void	setWidth (float width)
	Set the total row width. Called automatically by `List` when the item is added.
void	unlockSettings ()
	Allow `applySettings()` to take effect again.
void	unlockTheme ()
	Resume reacting to global theme changes.

Public Attributes
sf::Color	bgDisabled = sf::Color::Transparent
sf::Color	bgHover = sf::Color(255, 255, 255, 18)
sf::Color	bgIdle = sf::Color::Transparent
sf::Color	disabledColor = sf::Color(60, 60, 60)
sf::Color	disabledTextColor = sf::Color(120, 120, 120)
sf::Color	dividerColor = sf::Color(80, 80, 80)
float	dividerThickness = 1.f
sf::Color	errorColor = sf::Color(220, 70, 70)
sf::Color	fillColor = sf::Color(40, 40, 40)
sf::Color	focusColor = sf::Color(100, 60, 200)
const sf::Font *	font = &FontManager<>::getDefault()
unsigned int	fontSize = 14
unsigned int	fontSizeSmall = 11
sf::Color	hoverColor = sf::Color(70, 130, 230)
sf::Color	mutedColor = sf::Color(120, 120, 120)
sf::Color	outlineColor = sf::Color(100, 100, 100)
float	outlineThickness = 1.5f
float	padding = 8.f
float	radius = 8.f
float	rowHeight = 0.f
	0 = auto-sized from content
float	slotGap = 8.f
	Pixel gap between start / content / end slots.
sf::Color	textColor = sf::Color::White

Protected Member Functions
void	draw (sf::RenderTarget &target, sf::RenderStates states) const override
void	onThemeApplied (const Theme &theme) override
	Called by `ThemeManager` when the active theme changes.

Detailed Description

A single row in a List with start, content and end slots.

Inspired by Ionic Framework's ion-item — each row has three optional slots that accept any ml::Core component:

Slot	Typical use
start	Icon, avatar, `Checkbox`, `Radio`
content	Label + description (built-in) or any `Core`
end	`Toggle`, `RectangleButton`, badge

Slot components are not owned by ListItem — the caller is responsible for their lifetime. Do NOT call addComponent on them separately; List handles drawing.

Usage — built-in label

ml::ListItem item;
item.setLabel("Dark mode");
item.setDescription("Reduces eye strain");
 
ml::PillToggle toggle;
item.setEnd(toggle);
 
list.add(item);   // add() accepts any ml::Core, including a pre-built ListItem

Usage — custom content slot

ml::ListItem item;
ml::CheckboxGroup group;
item.setContent(group);    // replaces built-in label
list.add(item);

See also: List, ListItemSettings, ListItemTheme, ListItemStyle

Definition at line 77 of file ListItem.h.

Member Typedef Documentation

◆ Flag

using ml::ListItem::Flag = ListItemManifest::Flag

Definition at line 83 of file ListItem.h.

◆ State

using ml::ListItem::State = ListItemManifest::State

Definition at line 84 of file ListItem.h.

Constructor & Destructor Documentation

◆ ListItem()

ml::ListItem::ListItem ( const sf::Font & font = FontManager<>::getDefault() )

explicit

Member Function Documentation

◆ applyFrom()

ListItemTheme & ml::ListItemTheme::applyFrom ( const Theme & t )

inlineoverridevirtualinherited

Populate all fields from the global Theme token set.

Subclasses call GraphicTheme::applyFrom(t) first, then apply their own token mappings.

Reimplemented from ml::ControlTheme.

Definition at line 36 of file ListItemTheme.h.

◆ applySettings()

template<typename S>

void ml::ListItem::applySettings ( const S & s )

inline

Definition at line 121 of file ListItem.h.

◆ applyStyle()

template<typename St>

void ml::ListItem::applyStyle ( const St & s )

inline

Definition at line 140 of file ListItem.h.

◆ applyTheme()

template<typename T>

void ml::ListItem::applyTheme ( const T & t )

inline

Definition at line 130 of file ListItem.h.

◆ draw()

void ml::ListItem::draw	(	sf::RenderTarget &	target,
		sf::RenderStates	states ) const

overrideprotected

◆ getBgDisabled()

sf::Color ml::ListItemTheme::getBgDisabled ( ) const

inlinenodiscardinherited

Definition at line 62 of file ListItemTheme.h.

◆ getBgHover()

sf::Color ml::ListItemTheme::getBgHover ( ) const

inlinenodiscardinherited

Definition at line 61 of file ListItemTheme.h.

◆ getBgIdle()

sf::Color ml::ListItemTheme::getBgIdle ( ) const

inlinenodiscardinherited

Definition at line 60 of file ListItemTheme.h.

◆ getDescription()

std::string ml::ListItem::getDescription ( ) const

nodiscard

◆ getDisabledColor()

sf::Color ml::ControlTheme::getDisabledColor ( ) const

inlinenodiscardinherited

Definition at line 75 of file ControlTheme.h.

◆ getDisabledTextColor()

sf::Color ml::ControlTheme::getDisabledTextColor ( ) const

inlinenodiscardinherited

Definition at line 76 of file ControlTheme.h.

◆ getDividerColor()

sf::Color ml::ListItemTheme::getDividerColor ( ) const

inlinenodiscardinherited

Definition at line 63 of file ListItemTheme.h.

◆ getDividerThickness()

float ml::ListItemTheme::getDividerThickness ( ) const

inlinenodiscardinherited

Definition at line 64 of file ListItemTheme.h.

◆ getErrorColor()

sf::Color ml::ControlTheme::getErrorColor ( ) const

inlinenodiscardinherited

Definition at line 74 of file ControlTheme.h.

◆ getFillColor()

sf::Color ml::GraphicTheme::getFillColor ( ) const

inlinenodiscardinherited

Definition at line 67 of file GraphicTheme.h.

◆ getFocusColor()

sf::Color ml::ControlTheme::getFocusColor ( ) const

inlinenodiscardinherited

Definition at line 73 of file ControlTheme.h.

◆ getFont()

const sf::Font * ml::ControlTheme::getFont ( ) const

inlinenodiscardinherited

Definition at line 80 of file ControlTheme.h.

◆ getFontSize()

unsigned int ml::ControlTheme::getFontSize ( ) const

inlinenodiscardinherited

Definition at line 81 of file ControlTheme.h.

◆ getFontSizeSmall()

unsigned int ml::ControlTheme::getFontSizeSmall ( ) const

inlinenodiscardinherited

Definition at line 82 of file ControlTheme.h.

◆ getGlobalBounds()

sf::FloatRect ml::ListItem::getGlobalBounds ( ) const

override

◆ getHoverColor()

sf::Color ml::ControlTheme::getHoverColor ( ) const

inlinenodiscardinherited

Definition at line 72 of file ControlTheme.h.

◆ getLabel()

std::string ml::ListItem::getLabel ( ) const

nodiscard

◆ getMutedColor()

sf::Color ml::ControlTheme::getMutedColor ( ) const

inlinenodiscardinherited

Definition at line 78 of file ControlTheme.h.

◆ getOutlineColor()

sf::Color ml::GraphicTheme::getOutlineColor ( ) const

inlinenodiscardinherited

Definition at line 68 of file GraphicTheme.h.

◆ getOutlineThickness()

float ml::GraphicTheme::getOutlineThickness ( ) const

inlinenodiscardinherited

Definition at line 69 of file GraphicTheme.h.

◆ getPadding()

float ml::ControlTheme::getPadding ( ) const

inlinenodiscardinherited

Definition at line 79 of file ControlTheme.h.

◆ getPosition()

sf::Vector2f ml::ListItem::getPosition ( ) const

override

◆ getRadius()

float ml::GraphicTheme::getRadius ( ) const

inlinenodiscardinherited

Definition at line 70 of file GraphicTheme.h.

◆ getRowHeight()

float ml::ListItemSettings::getRowHeight ( ) const

inlinenodiscardinherited

Definition at line 39 of file ListItemSettings.h.

◆ getSlotGap()

float ml::ListItemSettings::getSlotGap ( ) const

inlinenodiscardinherited

Definition at line 40 of file ListItemSettings.h.

◆ getTextColor()

sf::Color ml::ControlTheme::getTextColor ( ) const

inlinenodiscardinherited

Definition at line 77 of file ControlTheme.h.

◆ getWidth()

float ml::ListItem::getWidth ( ) const

inlinenodiscard

Definition at line 207 of file ListItem.h.

◆ isEnabled()

bool ml::ListItem::isEnabled ( ) const

nodiscard

◆ isSettingsLocked()

bool ml::Themeable::isSettingsLocked ( ) const

inlinenodiscardinherited

Return true if applySettings() is currently blocked.

Definition at line 115 of file Themeable.h.

◆ isThemeLocked()

bool ml::Themeable::isThemeLocked ( ) const

inlinenodiscardinherited

Return true if this component ignores theme changes.

Definition at line 97 of file Themeable.h.

◆ lockSettings()

void ml::Themeable::lockSettings ( )

inlineinherited

Prevent applySettings() from taking effect.

Explicit individual setter calls still work normally. Only blocks the batch applySettings() path.

Definition at line 107 of file Themeable.h.

◆ lockTheme()

void ml::Themeable::lockTheme ( )

inlineinherited

Prevent automatic re-styling when the global theme changes.

The component keeps its current visual state. Explicit individual setter calls still work normally.

Definition at line 85 of file Themeable.h.

◆ onClick()

void ml::ListItem::onClick ( std::function< void()> callback )

Register a callback fired when the row is clicked.

◆ onThemeApplied()

void ml::ListItem::onThemeApplied ( const Theme & theme )

overrideprotectedvirtual

Called by ThemeManager when the active theme changes.

Override in your component to re-style from the new theme. Always check isThemeLocked() first:

void onThemeApplied(const Theme& theme) override
{
    if (isThemeLocked()) return;
    MySettings::applyTheme(theme);
    syncFromSettings();
}

Parameters

theme The newly active theme.

Implements ml::Themeable.

◆ setBgDisabled()

void ml::ListItemTheme::setBgDisabled ( const sf::Color & c )

inlineinherited

Definition at line 68 of file ListItemTheme.h.

◆ setBgHover()

void ml::ListItemTheme::setBgHover ( const sf::Color & c )

inlineinherited

Definition at line 67 of file ListItemTheme.h.

◆ setBgIdle()

void ml::ListItemTheme::setBgIdle ( const sf::Color & c )

inlineinherited

Definition at line 66 of file ListItemTheme.h.

◆ setContent()

void ml::ListItem::setContent ( ml::Core & component )

Replace the built-in label/description with a custom component.

When set, setLabel and setDescription have no visual effect. The component is not owned — do not addComponent it separately.

◆ setDescription()

void ml::ListItem::setDescription ( const std::string & text )

Set an optional secondary description line below the label. Pass an empty string to remove.

◆ setDisabledColor()

void ml::ControlTheme::setDisabledColor ( const sf::Color & c )

inlineinherited

Definition at line 87 of file ControlTheme.h.

◆ setDisabledTextColor()

void ml::ControlTheme::setDisabledTextColor ( const sf::Color & c )

inlineinherited

Definition at line 88 of file ControlTheme.h.

◆ setDividerColor()

void ml::ListItemTheme::setDividerColor ( const sf::Color & c )

inlineinherited

Definition at line 69 of file ListItemTheme.h.

◆ setDividerThickness()

void ml::ListItemTheme::setDividerThickness ( float t )

inlineinherited

Definition at line 70 of file ListItemTheme.h.

◆ setEnabled()

void ml::ListItem::setEnabled ( bool enabled )

◆ setEnd()

void ml::ListItem::setEnd ( ml::Core & component )

Assign a component to the end (right) slot.

Typical use: PillToggle, RectangleButton, badge. The component is not owned — do not addComponent it separately.

◆ setErrorColor()

void ml::ControlTheme::setErrorColor ( const sf::Color & c )

inlineinherited

Definition at line 86 of file ControlTheme.h.

◆ setFillColor()

void ml::GraphicTheme::setFillColor ( const sf::Color & c )

inlineinherited

Definition at line 72 of file GraphicTheme.h.

◆ setFocusColor()

void ml::ControlTheme::setFocusColor ( const sf::Color & c )

inlineinherited

Definition at line 85 of file ControlTheme.h.

◆ setFont() [1/2]

void ml::ControlTheme::setFont ( const sf::Font && )

deleteinherited

◆ setFont() [2/2]

void ml::ControlTheme::setFont ( const sf::Font & f )

inlineinherited

Definition at line 92 of file ControlTheme.h.

◆ setFontSize()

void ml::ControlTheme::setFontSize ( unsigned int s )

inlineinherited

Definition at line 94 of file ControlTheme.h.

◆ setFontSizeSmall()

void ml::ControlTheme::setFontSizeSmall ( unsigned int s )

inlineinherited

Definition at line 95 of file ControlTheme.h.

◆ setHoverColor()

void ml::ControlTheme::setHoverColor ( const sf::Color & c )

inlineinherited

Definition at line 84 of file ControlTheme.h.

◆ setLabel()

void ml::ListItem::setLabel ( const std::string & text )

Set the primary label text.

◆ setMutedColor()

void ml::ControlTheme::setMutedColor ( const sf::Color & c )

inlineinherited

Definition at line 90 of file ControlTheme.h.

◆ setOutlineColor()

void ml::GraphicTheme::setOutlineColor ( const sf::Color & c )

inlineinherited

Definition at line 73 of file GraphicTheme.h.

◆ setOutlineThickness()

void ml::GraphicTheme::setOutlineThickness ( float t )

inlineinherited

Definition at line 74 of file GraphicTheme.h.

◆ setPadding()

void ml::ControlTheme::setPadding ( float p )

inlineinherited

Definition at line 91 of file ControlTheme.h.

◆ setPosition()

void ml::ListItem::setPosition ( const sf::Vector2f & position )

override

◆ setRadius()

void ml::GraphicTheme::setRadius ( float r )

inlineinherited

Definition at line 75 of file GraphicTheme.h.

◆ setRowHeight()

void ml::ListItemSettings::setRowHeight ( float h )

inlineinherited

Definition at line 42 of file ListItemSettings.h.

◆ setSlotGap()

void ml::ListItemSettings::setSlotGap ( float g )

inlineinherited

Definition at line 43 of file ListItemSettings.h.

◆ setStart()

void ml::ListItem::setStart ( ml::Core & component )

Assign a component to the start (left) slot.

Typical use: icon, Checkbox, RadioButton, avatar. The component is not owned — do not addComponent it separately.

◆ setTextColor()

void ml::ControlTheme::setTextColor ( const sf::Color & c )

inlineinherited

Definition at line 89 of file ControlTheme.h.

◆ setWidth()

void ml::ListItem::setWidth ( float width )

Set the total row width. Called automatically by List when the item is added.

◆ unlockSettings()

void ml::Themeable::unlockSettings ( )

inlineinherited

Allow applySettings() to take effect again.

Definition at line 112 of file Themeable.h.

◆ unlockTheme()

void ml::Themeable::unlockTheme ( )

inlineinherited

Resume reacting to global theme changes.

Does NOT immediately re-apply the current theme — call ThemeManager::get() and pass it to onThemeApplied() manually if you want to re-sync immediately after unlocking.

Definition at line 94 of file Themeable.h.

Member Data Documentation

◆ bgDisabled

sf::Color ml::ListItemTheme::bgDisabled = sf::Color::Transparent

inherited

Definition at line 30 of file ListItemTheme.h.

◆ bgHover

sf::Color ml::ListItemTheme::bgHover = sf::Color(255, 255, 255, 18)

inherited

Definition at line 29 of file ListItemTheme.h.

◆ bgIdle

sf::Color ml::ListItemTheme::bgIdle = sf::Color::Transparent

inherited

Definition at line 28 of file ListItemTheme.h.

◆ disabledColor

sf::Color ml::ControlTheme::disabledColor = sf::Color(60, 60, 60)

inherited

Definition at line 33 of file ControlTheme.h.

◆ disabledTextColor

sf::Color ml::ControlTheme::disabledTextColor = sf::Color(120, 120, 120)

inherited

Definition at line 34 of file ControlTheme.h.

◆ dividerColor

sf::Color ml::ListItemTheme::dividerColor = sf::Color(80, 80, 80)

inherited

Definition at line 31 of file ListItemTheme.h.

◆ dividerThickness

float ml::ListItemTheme::dividerThickness = 1.f

inherited

Definition at line 32 of file ListItemTheme.h.

◆ errorColor

sf::Color ml::ControlTheme::errorColor = sf::Color(220, 70, 70)

inherited

Definition at line 32 of file ControlTheme.h.

◆ fillColor

sf::Color ml::GraphicTheme::fillColor = sf::Color(40, 40, 40)

inherited

Definition at line 43 of file GraphicTheme.h.

◆ focusColor

sf::Color ml::ControlTheme::focusColor = sf::Color(100, 60, 200)

inherited

Definition at line 31 of file ControlTheme.h.

◆ font

const sf::Font* ml::ControlTheme::font = &FontManager<>::getDefault()

inherited

Definition at line 39 of file ControlTheme.h.

◆ fontSize

unsigned int ml::ControlTheme::fontSize = 14

inherited

Definition at line 40 of file ControlTheme.h.

◆ fontSizeSmall

unsigned int ml::ControlTheme::fontSizeSmall = 11

inherited

Definition at line 41 of file ControlTheme.h.

◆ hoverColor

sf::Color ml::ControlTheme::hoverColor = sf::Color(70, 130, 230)

inherited

Definition at line 30 of file ControlTheme.h.

◆ mutedColor

sf::Color ml::ControlTheme::mutedColor = sf::Color(120, 120, 120)

inherited

Definition at line 36 of file ControlTheme.h.

◆ outlineColor

sf::Color ml::GraphicTheme::outlineColor = sf::Color(100, 100, 100)

inherited

Definition at line 44 of file GraphicTheme.h.

◆ outlineThickness

float ml::GraphicTheme::outlineThickness = 1.5f

inherited

Definition at line 45 of file GraphicTheme.h.

◆ padding

float ml::ControlTheme::padding = 8.f

inherited

Definition at line 37 of file ControlTheme.h.

◆ radius

float ml::GraphicTheme::radius = 8.f

inherited

Definition at line 46 of file GraphicTheme.h.

◆ rowHeight

float ml::ListItemSettings::rowHeight = 0.f

inherited

0 = auto-sized from content

Definition at line 26 of file ListItemSettings.h.

◆ slotGap

float ml::ListItemSettings::slotGap = 8.f

inherited

Pixel gap between start / content / end slots.

Definition at line 27 of file ListItemSettings.h.

◆ textColor

sf::Color ml::ControlTheme::textColor = sf::Color::White

inherited

Definition at line 35 of file ControlTheme.h.

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

Graphics/Controls/ListItem.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Usage — built-in label

Usage — custom content slot

Member Typedef Documentation

◆ Flag

◆ State

Constructor & Destructor Documentation

◆ ListItem()

Member Function Documentation

◆ applyFrom()

◆ applySettings()

◆ applyStyle()

◆ applyTheme()

◆ draw()

◆ getBgDisabled()

◆ getBgHover()

◆ getBgIdle()

◆ getDescription()

◆ getDisabledColor()

◆ getDisabledTextColor()

◆ getDividerColor()

◆ getDividerThickness()

◆ getErrorColor()

◆ getFillColor()

◆ getFocusColor()

◆ getFont()

◆ getFontSize()

◆ getFontSizeSmall()

◆ getGlobalBounds()

◆ getHoverColor()

◆ getLabel()

◆ getMutedColor()

◆ getOutlineColor()

◆ getOutlineThickness()

◆ getPadding()

◆ getPosition()

◆ getRadius()

◆ getRowHeight()

◆ getSlotGap()

◆ getTextColor()

◆ getWidth()

◆ isEnabled()

◆ isSettingsLocked()

◆ isThemeLocked()

◆ lockSettings()

◆ lockTheme()

◆ onClick()

◆ onThemeApplied()

◆ setBgDisabled()

◆ setBgHover()

◆ setBgIdle()

◆ setContent()

◆ setDescription()

◆ setDisabledColor()

◆ setDisabledTextColor()

◆ setDividerColor()

◆ setDividerThickness()

◆ setEnabled()

◆ setEnd()

◆ setErrorColor()

◆ setFillColor()

◆ setFocusColor()

◆ setFont() [1/2]

◆ setFont() [2/2]

◆ setFontSize()

◆ setFontSizeSmall()

◆ setHoverColor()

◆ setLabel()

◆ setMutedColor()

◆ setOutlineColor()

◆ setOutlineThickness()

◆ setPadding()

◆ setPosition()

◆ setRadius()

◆ setRowHeight()

◆ setSlotGap()