Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CGUIControlSeparatorSetting Class Reference

#include <GUIControlSettings.h>

Inheritance diagram for CGUIControlSeparatorSetting:
CGUIControlBaseSetting ILocalizer

Public Member Functions

 CGUIControlSeparatorSetting (CGUIImage *pImage, int id, ILocalizer *localizer)
 
 ~CGUIControlSeparatorSetting () override
 
CGUIControlGetControl () override
 
bool OnClick () override
 
void Update ()
 
void Clear () override
 Clears the attached control. More...
 
virtual void Update (bool updateDisplayOnly=false)
 
- 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. 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)
 

Additional Inherited Members

- 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 Attributes inherited from CGUIControlBaseSetting
int m_id
 
std::shared_ptr< CSettingm_pSetting
 
ILocalizerm_localizer
 
bool m_delayed
 
bool m_valid
 

Constructor & Destructor Documentation

◆ CGUIControlSeparatorSetting()

CGUIControlSeparatorSetting::CGUIControlSeparatorSetting ( CGUIImage pImage,
int  id,
ILocalizer localizer 
)

◆ ~CGUIControlSeparatorSetting()

CGUIControlSeparatorSetting::~CGUIControlSeparatorSetting ( )
overridedefault

Member Function Documentation

◆ Clear()

void CGUIControlSeparatorSetting::Clear ( )
inlineoverridevirtual

Clears the attached control.

Implements CGUIControlBaseSetting.

◆ GetControl()

CGUIControl * CGUIControlSeparatorSetting::GetControl ( )
inlineoverridevirtual

Reimplemented from CGUIControlBaseSetting.

◆ OnClick()

bool CGUIControlSeparatorSetting::OnClick ( )
inlineoverridevirtual

Reimplemented from CGUIControlBaseSetting.

◆ Update() [1/2]

void CGUIControlSeparatorSetting::Update ( void  )
inline

◆ Update() [2/2]

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

Reimplemented from CGUIControlBaseSetting.


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