A slide-in panel anchored to the left or right edge of the window. More...

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

Inheritance diagram for ml::SideMenu:

Public Types
using	Anchor = SideMenuSettings::Anchor
using	Flag = SideMenuManifest::Flag
using	Mode = SideMenuSettings::Mode
using	State = SideMenuManifest::State

Public Member Functions
	SideMenu (Mode mode=Mode::OVERLAY, Anchor anchor=Anchor::LEFT, const sf::Font &font=FontManager<>::getDefault())
SideMenuTheme &	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)
void	close ()
sf::Color	getDisabledColor () const
sf::Color	getDisabledTextColor () 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
ml::List &	getList ()
	Return the internal `List` for configuration.
sf::Color	getMutedColor () const
sf::Color	getOutlineColor () const
float	getOutlineThickness () const
float	getPadding () const
float	getPanelWidth () const
sf::Vector2f	getPosition () const override
float	getRadius () const
sf::Color	getTextColor () const
bool	isOpen () 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	onClose (std::function< void()> cb)
	Called when the panel finishes closing.
void	onOpen (std::function< void()> cb)
	Called when the panel finishes opening.
void	open ()
void	setAnchor (Anchor a)
void	setAnimDuration (float d)
void	setBackdropColor (const sf::Color &c)
void	setContent (ml::Core &component)
	Replace the internal list with any component.
void	setDisabledColor (const sf::Color &c)
void	setDisabledTextColor (const sf::Color &c)
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	setHamburgerBg (const sf::Color &c)
void	setHamburgerColor (const sf::Color &c)
void	setHamburgerPosition (const sf::Vector2f &pos)
void	setHamburgerSize (float s)
void	setHoverColor (const sf::Color &c)
void	setMode (Mode m)
void	setMutedColor (const sf::Color &c)
void	setOutlineColor (const sf::Color &c)
void	setOutlineThickness (float t)
void	setPadding (float p)
void	setPanelBg (const sf::Color &c)
void	setPanelHeight (float h)
void	setPanelWidth (float w)
void	setPosition (const sf::Vector2f &position) override
void	setRadius (float r)
void	setTextColor (const sf::Color &c)
void	toggle ()
void	unlockSettings ()
	Allow `applySettings()` to take effect again.
void	unlockTheme ()
	Resume reacting to global theme changes.

Public Attributes
Anchor	anchor = Anchor::LEFT
float	animDuration = 0.25f
	seconds
sf::Color	backdropColor = sf::Color(0, 0, 0, 160)
sf::Color	disabledColor = sf::Color(60, 60, 60)
sf::Color	disabledTextColor = sf::Color(120, 120, 120)
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	hamburgerBg = sf::Color::Transparent
sf::Color	hamburgerColor = sf::Color(220, 220, 220)
float	hamburgerSize = 48.f
	hit-area square
sf::Color	hoverColor = sf::Color(70, 130, 230)
Mode	mode = Mode::OVERLAY
sf::Color	mutedColor = sf::Color(120, 120, 120)
sf::Color	outlineColor = sf::Color(100, 100, 100)
float	outlineThickness = 1.5f
float	padding = 8.f
sf::Color	panelBg = sf::Color(28, 28, 36)
float	panelHeight = 0.f
	0 = use window height
float	panelWidth = 280.f
float	radius = 8.f
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 slide-in panel anchored to the left or right edge of the window.

SideMenu manages a panel that slides in/out with a built-in hamburger button. It supports two display modes:

OVERLAY — slides over the content with a semi-transparent backdrop.
PUSH — slides in alongside the content (fires onOpen / onClose callbacks so the app can shift its layout accordingly).

The panel can host a List (via getList()) or any ml::Core component (via setContent()). The SideMenu draws and positions the content internally; no separate addComponent() call is needed.

Usage

ml::SideMenu menu;
menu.setPanelWidth(280.f);
 
auto& list = menu.getList();
list.addItem("Home");
list.addItem("Settings");
list.addItem("Profile");
 
addComponent(menu);   // hamburger, backdrop, and panel drawing

PUSH mode — shift layout on open

menu.setMode(ml::SideMenuSettings::Mode::PUSH);
menu.onOpen([&] { myContent.setPosition({menu.getPanelWidth(), 0.f}); });
menu.onClose([&]{ myContent.setPosition({0.f, 0.f}); });

See also: SideMenuSettings, SideMenuTheme, SideMenuStyle, List

Definition at line 70 of file SideMenu.h.

Member Typedef Documentation

◆ Anchor

using ml::SideMenu::Anchor = SideMenuSettings::Anchor

Definition at line 79 of file SideMenu.h.

◆ Flag

using ml::SideMenu::Flag = SideMenuManifest::Flag

Definition at line 76 of file SideMenu.h.

◆ Mode

using ml::SideMenu::Mode = SideMenuSettings::Mode

Definition at line 78 of file SideMenu.h.

◆ State

using ml::SideMenu::State = SideMenuManifest::State

Definition at line 77 of file SideMenu.h.

Constructor & Destructor Documentation

◆ SideMenu()

ml::SideMenu::SideMenu	(	Mode	mode = Mode::OVERLAY,
		Anchor	anchor = Anchor::LEFT,
		const sf::Font &	font = FontManager<>::getDefault() )

explicit

Member Function Documentation

◆ applyFrom()

SideMenuTheme & ml::SideMenuTheme::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 17 of file SideMenuTheme.h.

◆ applySettings()

template<typename S>

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

inline

Definition at line 120 of file SideMenu.h.

◆ applyStyle()

template<typename St>

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

inline

Definition at line 139 of file SideMenu.h.

◆ applyTheme()

template<typename T>

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

inline

Definition at line 129 of file SideMenu.h.

◆ close()

void ml::SideMenu::close ( )

◆ draw()

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

overrideprotected

◆ 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.

◆ 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::SideMenu::getGlobalBounds ( ) const

override

◆ getHoverColor()

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

inlinenodiscardinherited

Definition at line 72 of file ControlTheme.h.

◆ getList()

ml::List & ml::SideMenu::getList ( )

Return the internal List for configuration.

The SideMenu draws and positions this list internally. List items receive events automatically — no separate addComponent() call is needed.

◆ 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.

◆ getPanelWidth()

float ml::SideMenu::getPanelWidth ( ) const

inlinenodiscard

Definition at line 187 of file SideMenu.h.

◆ getPosition()

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

override

◆ getRadius()

float ml::GraphicTheme::getRadius ( ) const

inlinenodiscardinherited

Definition at line 70 of file GraphicTheme.h.

◆ getTextColor()

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

inlinenodiscardinherited

Definition at line 77 of file ControlTheme.h.

◆ isOpen()

bool ml::SideMenu::isOpen ( ) 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.

◆ onClose()

void ml::SideMenu::onClose ( std::function< void()> cb )

Called when the panel finishes closing.

◆ onOpen()

void ml::SideMenu::onOpen ( std::function< void()> cb )

Called when the panel finishes opening.

◆ onThemeApplied()

void ml::SideMenu::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.

◆ open()

void ml::SideMenu::open ( )

◆ setAnchor()

void ml::SideMenuSettings::setAnchor ( Anchor a )

inlineinherited

Definition at line 28 of file SideMenuSettings.h.

◆ setAnimDuration()

void ml::SideMenuSettings::setAnimDuration ( float d )

inlineinherited

Definition at line 31 of file SideMenuSettings.h.

◆ setBackdropColor()

void ml::SideMenuTheme::setBackdropColor ( const sf::Color & c )

inlineinherited

Definition at line 33 of file SideMenuTheme.h.

◆ setContent()

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

Replace the internal list with any component.

The SideMenu draws and positions the component internally. The component's events fire automatically — no separate addComponent() call is needed.

◆ 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.

◆ 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.

◆ setHamburgerBg()

void ml::SideMenuTheme::setHamburgerBg ( const sf::Color & c )

inlineinherited

Definition at line 35 of file SideMenuTheme.h.

◆ setHamburgerColor()

void ml::SideMenuTheme::setHamburgerColor ( const sf::Color & c )

inlineinherited

Definition at line 34 of file SideMenuTheme.h.

◆ setHamburgerPosition()

void ml::SideMenu::setHamburgerPosition ( const sf::Vector2f & pos )

◆ setHamburgerSize()

void ml::SideMenuSettings::setHamburgerSize ( float s )

inlineinherited

Definition at line 32 of file SideMenuSettings.h.

◆ setHoverColor()

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

inlineinherited

Definition at line 84 of file ControlTheme.h.

◆ setMode()

void ml::SideMenuSettings::setMode ( Mode m )

inlineinherited

Definition at line 27 of file SideMenuSettings.h.

◆ 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.

◆ setPanelBg()

void ml::SideMenuTheme::setPanelBg ( const sf::Color & c )

inlineinherited

Definition at line 32 of file SideMenuTheme.h.

◆ setPanelHeight()

void ml::SideMenuSettings::setPanelHeight ( float h )

inlineinherited

Definition at line 30 of file SideMenuSettings.h.

◆ setPanelWidth()

void ml::SideMenuSettings::setPanelWidth ( float w )

inlineinherited

Definition at line 29 of file SideMenuSettings.h.

◆ setPosition()

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

override

◆ setRadius()

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

inlineinherited

Definition at line 75 of file GraphicTheme.h.

◆ setTextColor()

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

inlineinherited

Definition at line 89 of file ControlTheme.h.

◆ toggle()

void ml::SideMenu::toggle ( )

◆ 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

◆ anchor

Anchor ml::SideMenuSettings::anchor = Anchor::LEFT

inherited

Definition at line 16 of file SideMenuSettings.h.

◆ animDuration

float ml::SideMenuSettings::animDuration = 0.25f

inherited

seconds

Definition at line 19 of file SideMenuSettings.h.

◆ backdropColor

sf::Color ml::SideMenuTheme::backdropColor = sf::Color(0, 0, 0, 160)

inherited

Definition at line 13 of file SideMenuTheme.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.

◆ 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.

◆ hamburgerBg

sf::Color ml::SideMenuTheme::hamburgerBg = sf::Color::Transparent

inherited

Definition at line 15 of file SideMenuTheme.h.

◆ hamburgerColor

sf::Color ml::SideMenuTheme::hamburgerColor = sf::Color(220, 220, 220)

inherited

Definition at line 14 of file SideMenuTheme.h.

◆ hamburgerSize

float ml::SideMenuSettings::hamburgerSize = 48.f

inherited

hit-area square

Definition at line 20 of file SideMenuSettings.h.

◆ hoverColor

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

inherited

Definition at line 30 of file ControlTheme.h.

◆ mode

Mode ml::SideMenuSettings::mode = Mode::OVERLAY

inherited

Definition at line 15 of file SideMenuSettings.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.

◆ panelBg

sf::Color ml::SideMenuTheme::panelBg = sf::Color(28, 28, 36)

inherited

Definition at line 12 of file SideMenuTheme.h.

◆ panelHeight

float ml::SideMenuSettings::panelHeight = 0.f

inherited

0 = use window height

Definition at line 18 of file SideMenuSettings.h.

◆ panelWidth

float ml::SideMenuSettings::panelWidth = 280.f

inherited

Definition at line 17 of file SideMenuSettings.h.

◆ radius

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

inherited

Definition at line 46 of file GraphicTheme.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/SideMenu.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Usage

PUSH mode — shift layout on open

Member Typedef Documentation

◆ Anchor

◆ Flag

◆ Mode

◆ State

Constructor & Destructor Documentation

◆ SideMenu()

Member Function Documentation

◆ applyFrom()

◆ applySettings()

◆ applyStyle()

◆ applyTheme()

◆ close()

◆ draw()

◆ getDisabledColor()

◆ getDisabledTextColor()

◆ getErrorColor()

◆ getFillColor()

◆ getFocusColor()

◆ getFont()

◆ getFontSize()

◆ getFontSizeSmall()

◆ getGlobalBounds()

◆ getHoverColor()

◆ getList()

◆ getMutedColor()

◆ getOutlineColor()

◆ getOutlineThickness()

◆ getPadding()

◆ getPanelWidth()

◆ getPosition()

◆ getRadius()

◆ getTextColor()

◆ isOpen()

◆ isSettingsLocked()

◆ isThemeLocked()

◆ lockSettings()

◆ lockTheme()

◆ onClose()

◆ onOpen()

◆ onThemeApplied()

◆ open()

◆ setAnchor()

◆ setAnimDuration()

◆ setBackdropColor()

◆ setContent()

◆ setDisabledColor()

◆ setDisabledTextColor()

◆ setErrorColor()

◆ setFillColor()

◆ setFocusColor()

◆ setFont() [1/2]

◆ setFont() [2/2]

◆ setFontSize()

◆ setFontSizeSmall()

◆ setHamburgerBg()

◆ setHamburgerColor()

◆ setHamburgerPosition()

◆ setHamburgerSize()

◆ setHoverColor()

◆ setMode()

◆ setMutedColor()

◆ setOutlineColor()

◆ setOutlineThickness()

◆ setPadding()

◆ setPanelBg()

◆ setPanelHeight()

◆ setPanelWidth()

◆ setPosition()

◆ setRadius()

◆ setTextColor()

◆ toggle()

◆ unlockSettings()