xbmc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CGUIControlBaseSetting Class Referenceabstract
Inheritance diagram for CGUIControlBaseSetting:
Inheritance graph
[legend]
Collaboration diagram for CGUIControlBaseSetting:
Collaboration graph
[legend]

Public Member Functions

 CGUIControlBaseSetting (int id, std::shared_ptr< CSetting > pSetting, ILocalizer *localizer)
 
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. 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.
 
void SetValid (bool valid)
 
virtual CGUIControlGetControl ()
 
virtual bool OnClick ()
 
void UpdateFromControl ()
 
void UpdateFromSetting (bool updateDisplayOnly=false)
 
virtual void Clear ()=0
 Clears the attached control.
 

Protected Member Functions

std::string Localize (std::uint32_t code) const override
 
virtual void Update (bool fromControl, bool updateDisplayOnly)
 

Protected Attributes

int m_id
 
std::shared_ptr< CSettingm_pSetting
 
ILocalizerm_localizer
 
bool m_delayed
 
bool m_valid
 

Member Function Documentation

◆ 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 ( void  ) 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()

◆ 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()

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