CGUIControlButtonSetting Class Reference

#include <GUIControlSettings.h>

Inheritance diagram for CGUIControlButtonSetting:

Public Member Functions
	CGUIControlButtonSetting (CGUIButtonControl *pButton, int id, std::shared_ptr< CSetting > pSetting, ILocalizer *localizer)
	~CGUIControlButtonSetting () 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)

Static Public Member Functions
static bool	GetPath (const std::shared_ptr< CSettingPath > &pathSetting, ILocalizer *localizer)

Protected Member Functions
void	Update (bool fromControl, bool updateDisplayOnly) override
void	OnSliderChange (void *data, CGUISliderControl *slider) override
	Callback function called whenever the user moves the slider.
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
Protected Member Functions inherited from ISliderCallback
virtual	~ISliderCallback ()=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

CGUIControlButtonSetting()

CGUIControlButtonSetting::CGUIControlButtonSetting	(	CGUIButtonControl *	pButton,
		int	id,
		std::shared_ptr< CSetting >	pSetting,
		ILocalizer *	localizer )

~CGUIControlButtonSetting()

CGUIControlButtonSetting::~CGUIControlButtonSetting ( )

overridedefault

Member Function Documentation

Clear()

void CGUIControlButtonSetting::Clear ( )

inlineoverridevirtual

Clears the attached control.

Implements CGUIControlBaseSetting.

GetControl()

CGUIControl * CGUIControlButtonSetting::GetControl ( )

inlineoverridevirtual

Reimplemented from CGUIControlBaseSetting.

GetPath()

bool CGUIControlButtonSetting::GetPath ( const std::shared_ptr< CSettingPath > & pathSetting, ILocalizer * localizer )

static

OnClick()

bool CGUIControlButtonSetting::OnClick ( )

overridevirtual

Reimplemented from CGUIControlBaseSetting.

OnSliderChange()

void CGUIControlButtonSetting::OnSliderChange ( void * data, CGUISliderControl * slider )

overrideprotectedvirtual

Callback function called whenever the user moves the slider.

Parameters

data	pointer of callbackData
slider	pointer to the slider control

Implements ISliderCallback.

Update()

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

overrideprotectedvirtual

Reimplemented from CGUIControlBaseSetting.

---

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

• GUIControlSettings.h
• GUIControlSettings.cpp