Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
CGUIControlLabelSetting Class Reference

#include <GUIControlSettings.h>

Inheritance diagram for CGUIControlLabelSetting:
CGUIControlBaseSetting ILocalizer

Public Member Functions

 CGUIControlLabelSetting (CGUIButtonControl *pButton, int id, std::shared_ptr< CSetting > pSetting, ILocalizer *localizer)
 ~CGUIControlLabelSetting () override=default
CGUIControlGetControl () 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< CSettingGetSetting ()
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)
virtual bool OnClick ()
void UpdateFromControl ()
void UpdateFromSetting (bool updateDisplayOnly=false)

Additional Inherited Members

- Protected Member Functions inherited from CGUIControlBaseSetting
std::string Localize (std::uint32_t code) const override
virtual void Update (bool fromControl, bool updateDisplayOnly)
- Protected Member Functions inherited from ILocalizer
 ILocalizer ()=default
virtual ~ILocalizer ()=default
- Protected Attributes inherited from CGUIControlBaseSetting
int m_id
std::shared_ptr< CSettingm_pSetting
bool m_delayed = false
bool m_valid = true

Constructor & Destructor Documentation

◆ CGUIControlLabelSetting()

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

◆ ~CGUIControlLabelSetting()

CGUIControlLabelSetting::~CGUIControlLabelSetting ( )

Member Function Documentation

◆ Clear()

void CGUIControlLabelSetting::Clear ( )

Clears the attached control.

Implements CGUIControlBaseSetting.

◆ GetControl()

CGUIControl * CGUIControlLabelSetting::GetControl ( )

Reimplemented from CGUIControlBaseSetting.

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