Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CGUIControlBaseSetting Class Referenceabstract

#include <GUIControlSettings.h>

Inheritance diagram for CGUIControlBaseSetting:
ILocalizer CGUIControlButtonSetting CGUIControlEditSetting CGUIControlGroupTitleSetting CGUIControlLabelSetting CGUIControlListSetting CGUIControlRadioButtonSetting CGUIControlRangeSetting CGUIControlSeparatorSetting CGUIControlSliderSetting CGUIControlSpinExSetting

Public Member Functions

 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. More...
 
bool IsDelayed () const
 Returns whether this setting should have delayed update. More...
 
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. More...
 
bool IsValid () const
 Returns whether the setting's value is valid or not. More...
 
void SetValid (bool valid)
 
virtual CGUIControl * GetControl ()
 
virtual bool OnClick ()
 
virtual void Update (bool updateDisplayOnly=false)
 
virtual void Clear ()=0
 Clears the attached control. More...
 

Protected Member Functions

std::string Localize (std::uint32_t code) const override
 
- Protected Member Functions inherited from ILocalizer
 ILocalizer ()=default
 
virtual ~ILocalizer ()=default
 

Protected Attributes

int m_id
 
std::shared_ptr< CSetting > m_pSetting
 
ILocalizer * m_localizer
 
bool m_delayed
 
bool m_valid
 

Constructor & Destructor Documentation

§ CGUIControlBaseSetting()

CGUIControlBaseSetting::CGUIControlBaseSetting ( int  id,
std::shared_ptr< CSetting >  pSetting,
ILocalizer *  localizer 
)

§ ~CGUIControlBaseSetting()

CGUIControlBaseSetting::~CGUIControlBaseSetting ( )
overridedefault

Member Function Documentation

§ Clear()

virtual void CGUIControlBaseSetting::Clear ( )
pure virtual

Clears the attached control.

Implemented in CGUIControlLabelSetting, CGUIControlGroupTitleSetting, CGUIControlSeparatorSetting, CGUIControlRangeSetting, CGUIControlSliderSetting, CGUIControlEditSetting, CGUIControlButtonSetting, CGUIControlListSetting, CGUIControlSpinExSetting, and CGUIControlRadioButtonSetting.

§ GetControl()

virtual CGUIControl* CGUIControlBaseSetting::GetControl ( )
inlinevirtual

Reimplemented in CGUIControlLabelSetting, CGUIControlGroupTitleSetting, CGUIControlSeparatorSetting, CGUIControlRangeSetting, CGUIControlSliderSetting, CGUIControlEditSetting, CGUIControlButtonSetting, CGUIControlListSetting, CGUIControlSpinExSetting, and CGUIControlRadioButtonSetting.

§ GetID()

int CGUIControlBaseSetting::GetID ( ) const
inline

§ GetSetting()

std::shared_ptr<CSetting> CGUIControlBaseSetting::GetSetting ( )
inline

§ IsDelayed()

bool CGUIControlBaseSetting::IsDelayed ( ) const
inline

Returns whether this setting should have delayed update.

Returns
true if the setting's update should be delayed
See also
SetDelayed()

§ IsEnabled()

bool CGUIControlBaseSetting::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.

Returns
true if the setting is enabled otherwise false
See also
SetEnabled()

§ IsValid()

bool CGUIControlBaseSetting::IsValid ( ) const
inline

Returns whether the setting's value is valid or not.

§ Localize()

std::string CGUIControlBaseSetting::Localize ( std::uint32_t  code) const
overrideprotectedvirtual

Implements ILocalizer.

§ OnClick()

virtual bool CGUIControlBaseSetting::OnClick ( )
inlinevirtual

Reimplemented in CGUIControlGroupTitleSetting, CGUIControlSeparatorSetting, CGUIControlRangeSetting, CGUIControlSliderSetting, CGUIControlEditSetting, CGUIControlButtonSetting, CGUIControlListSetting, CGUIControlSpinExSetting, and CGUIControlRadioButtonSetting.

§ SetDelayed()

void CGUIControlBaseSetting::SetDelayed ( )
inline

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.

See also
IsDelayed()

§ SetValid()

void CGUIControlBaseSetting::SetValid ( bool  valid)
inline

§ Update()

void CGUIControlBaseSetting::Update ( bool  updateDisplayOnly = false)
virtual

Reimplemented in CGUIControlRangeSetting, CGUIControlSliderSetting, CGUIControlEditSetting, CGUIControlButtonSetting, CGUIControlListSetting, CGUIControlSpinExSetting, and CGUIControlRadioButtonSetting.

Member Data Documentation

§ m_delayed

bool CGUIControlBaseSetting::m_delayed
protected

§ m_id

int CGUIControlBaseSetting::m_id
protected

§ m_localizer

ILocalizer* CGUIControlBaseSetting::m_localizer
protected

§ m_pSetting

std::shared_ptr<CSetting> CGUIControlBaseSetting::m_pSetting
protected

§ m_valid

bool CGUIControlBaseSetting::m_valid
protected
The documentation for this class was generated from the following files: