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

#include <SettingControl.h>

Inheritance diagram for CSettingControlList:
CSettingControlFormattedRange ISettingControl

Public Member Functions

 CSettingControlList ()=default
 
 ~CSettingControlList () override=default
 
std::string GetType () const override
 
bool Deserialize (const TiXmlNode *node, bool update=false) override
 
bool SetFormat (const std::string &format) override
 
int GetHeading () const
 
void SetHeading (int heading)
 
bool CanMultiSelect () const
 
void SetMultiSelect (bool multiselect)
 
bool HideValue () const
 
void SetHideValue (bool hideValue)
 
SettingControlListValueFormatter GetFormatter () const
 
void SetFormatter (SettingControlListValueFormatter formatter)
 
- Public Member Functions inherited from CSettingControlFormattedRange
 ~CSettingControlFormattedRange () override=default
 
int GetFormatLabel () const
 
void SetFormatLabel (int formatLabel)
 
const std::string & GetFormatString () const
 
void SetFormatString (const std::string &formatString)
 
int GetMinimumLabel () const
 
void SetMinimumLabel (int minimumLabel)
 
- Public Member Functions inherited from ISettingControl
 ISettingControl ()=default
 
virtual ~ISettingControl ()=default
 
const std::string & GetFormat () const
 
bool GetDelayed () const
 
void SetDelayed (bool delayed)
 

Protected Attributes

int m_heading = -1
 
bool m_multiselect = false
 
bool m_hideValue = false
 
SettingControlListValueFormatter m_formatter = nullptr
 
- Protected Attributes inherited from CSettingControlFormattedRange
int m_formatLabel = -1
 
std::string m_formatString = "%i"
 
int m_minimumLabel = -1
 
- Protected Attributes inherited from ISettingControl
bool m_delayed = false
 
std::string m_format
 

Additional Inherited Members

- Protected Member Functions inherited from CSettingControlFormattedRange
 CSettingControlFormattedRange ()=default
 

Constructor & Destructor Documentation

◆ CSettingControlList()

CSettingControlList::CSettingControlList ( )
default

◆ ~CSettingControlList()

CSettingControlList::~CSettingControlList ( )
overridedefault

Member Function Documentation

◆ CanMultiSelect()

bool CSettingControlList::CanMultiSelect ( ) const
inline

◆ Deserialize()

bool CSettingControlList::Deserialize ( const TiXmlNode *  node,
bool  update = false 
)
overridevirtual

Reimplemented from CSettingControlFormattedRange.

◆ GetFormatter()

SettingControlListValueFormatter CSettingControlList::GetFormatter ( ) const
inline

◆ GetHeading()

int CSettingControlList::GetHeading ( ) const
inline

◆ GetType()

std::string CSettingControlList::GetType ( ) const
inlineoverridevirtual

Implements ISettingControl.

◆ HideValue()

bool CSettingControlList::HideValue ( ) const
inline

◆ SetFormat()

bool CSettingControlList::SetFormat ( const std::string &  format)
overridevirtual

Reimplemented from ISettingControl.

◆ SetFormatter()

void CSettingControlList::SetFormatter ( SettingControlListValueFormatter  formatter)
inline

◆ SetHeading()

void CSettingControlList::SetHeading ( int  heading)
inline

◆ SetHideValue()

void CSettingControlList::SetHideValue ( bool  hideValue)
inline

◆ SetMultiSelect()

void CSettingControlList::SetMultiSelect ( bool  multiselect)
inline

Member Data Documentation

◆ m_formatter

SettingControlListValueFormatter CSettingControlList::m_formatter = nullptr
protected

◆ m_heading

int CSettingControlList::m_heading = -1
protected

◆ m_hideValue

bool CSettingControlList::m_hideValue = false
protected

◆ m_multiselect

bool CSettingControlList::m_multiselect = false
protected

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