CGUIControlEditSetting Class Reference

#include <GUIControlSettings.h>

Inheritance diagram for CGUIControlEditSetting:

Public Member Functions
	CGUIControlEditSetting (CGUIEditControl *pButton, int id, const std::shared_ptr< CSetting > &pSetting, ILocalizer *localizer)
	~CGUIControlEditSetting () override
CGUIControl *	GetControl () override
bool	OnClick () override
void	Clear () override
	Clears the attached control.
Public Member Functions inherited from CGUIControlBaseSetting
	CGUIControlBaseSetting (int id, std::shared_ptr< CSetting > pSetting, ILocalizer *localizer)
	~CGUIControlBaseSetting () override=default
int	GetID () const
std::shared_ptr< CSetting >	GetSetting ()
void	SetDelayed ()
	Specifies that this setting should update after a delay Useful for settings that have options to navigate through and may take a while, or require additional input to update once the final setting is chosen. Settings default to updating instantly.
bool	IsDelayed () const
	Returns whether this setting should have delayed update.
bool	IsEnabled () const
	Returns whether this setting is enabled or disabled This state is independent of the real enabled state of a setting control but represents the enabled state of the setting itself based on specific conditions.
bool	IsValid () const
	Returns whether the setting's value is valid or not.
void	SetValid (bool valid)
void	UpdateFromControl ()
void	UpdateFromSetting (bool updateDisplayOnly=false)

Protected Member Functions
void	Update (bool fromControl, bool updateDisplayOnly) override
Protected Member Functions inherited from CGUIControlBaseSetting
std::string	Localize (std::uint32_t code) const override
Protected Member Functions inherited from ILocalizer
	ILocalizer ()=default
virtual	~ILocalizer ()=default

Additional Inherited Members
Protected Attributes inherited from CGUIControlBaseSetting
int	m_id
std::shared_ptr< CSetting >	m_pSetting
ILocalizer *	m_localizer
bool	m_delayed = false
bool	m_valid = true

Constructor & Destructor Documentation

CGUIControlEditSetting()

CGUIControlEditSetting::CGUIControlEditSetting	(	CGUIEditControl *	pButton,
		int	id,
		const std::shared_ptr< CSetting > &	pSetting,
		ILocalizer *	localizer )

~CGUIControlEditSetting()

CGUIControlEditSetting::~CGUIControlEditSetting ( )

overridedefault

Member Function Documentation

Clear()

void CGUIControlEditSetting::Clear ( )

inlineoverridevirtual

Clears the attached control.

Implements CGUIControlBaseSetting.

GetControl()

CGUIControl * CGUIControlEditSetting::GetControl ( )

inlineoverridevirtual

Reimplemented from CGUIControlBaseSetting.

OnClick()

bool CGUIControlEditSetting::OnClick ( )

overridevirtual

Reimplemented from CGUIControlBaseSetting.

Update()

void CGUIControlEditSetting::Update ( bool fromControl, bool updateDisplayOnly )

overrideprotectedvirtual

Reimplemented from CGUIControlBaseSetting.

---

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

• GUIControlSettings.h
• GUIControlSettings.cpp