class PVRSettingDefinition

PVR add-on setting definition
Representation of a setting definition. More...

Classes
class	kodi::addon::PVRSettingDefinition

Functions
	kodi::addon::PVRSettingDefinition::PVRSettingDefinition (unsigned int settingDefId, const std::string &settingDefName, uint64_t readonlyConditions, const PVRIntSettingDefinition &settingDef)
	Class constructor with integrated values.
	kodi::addon::PVRSettingDefinition::PVRSettingDefinition (unsigned int settingDefId, const std::string &settingDefName, uint64_t readonlyConditions, const PVRStringSettingDefinition &settingDef)
	Class constructor with integrated values.
	kodi::addon::PVRSettingDefinition::PVRSettingDefinition (unsigned int settingDefId, const std::string &settingDefName, PVR_SETTING_TYPE eType, uint64_t readonlyConditions, const PVRIntSettingDefinition &intSettingDef, const PVRStringSettingDefinition &stringSettingDef)
	Class constructor with integrated values.
void	kodi::addon::PVRSettingDefinition::SetId (unsigned int defId)
	required This setting definition's identifier.
unsigned int	kodi::addon::PVRSettingDefinition::GetId () const
	To get with SetId changed values.
void	kodi::addon::PVRSettingDefinition::SetName (const std::string &name)
	required A short localized string with the name of the setting.
std::string	kodi::addon::PVRSettingDefinition::GetName () const
	To get with SetName changed values.
void	kodi::addon::PVRSettingDefinition::SetType (PVR_SETTING_TYPE eType)
	required This setting definition's identifier.
PVR_SETTING_TYPE	kodi::addon::PVRSettingDefinition::GetType () const
	To get with SetType changed values.
void	kodi::addon::PVRSettingDefinition::SetReadonlyConditions (uint64_t conditions)
	optional The read-only conditions value for this setting. PVR_SETTING_READONLY_CONDITION_* enum values
uint64_t	kodi::addon::PVRSettingDefinition::GetReadonlyConditions () const
	To get with SetReadonlyConditions changed values.
void	kodi::addon::PVRSettingDefinition::SetIntDefinition (const PVRIntSettingDefinition &def)
	optional
PVRIntSettingDefinition	kodi::addon::PVRSettingDefinition::GetIntDefinition () const
	To get with SetIntDefinition changed values.
void	kodi::addon::PVRSettingDefinition::SetStringDefinition (const PVRStringSettingDefinition &def)
	optional
PVRStringSettingDefinition	kodi::addon::PVRSettingDefinition::GetStringDefinition () const
	To get with SetStringDefinition changed values.

Detailed Description

PVR add-on setting definition
Representation of a setting definition.

---

Function Documentation

GetId()

unsigned int kodi::addon::PVRSettingDefinition::GetId ( ) const

inline

To get with SetId changed values.

GetIntDefinition()

PVRIntSettingDefinition kodi::addon::PVRSettingDefinition::GetIntDefinition ( ) const

inline

To get with SetIntDefinition changed values.

GetName()

std::string kodi::addon::PVRSettingDefinition::GetName ( ) const

inline

To get with SetName changed values.

GetReadonlyConditions()

uint64_t kodi::addon::PVRSettingDefinition::GetReadonlyConditions ( ) const

inline

To get with SetReadonlyConditions changed values.

GetStringDefinition()

PVRStringSettingDefinition kodi::addon::PVRSettingDefinition::GetStringDefinition ( ) const

inline

To get with SetStringDefinition changed values.

GetType()

PVR_SETTING_TYPE kodi::addon::PVRSettingDefinition::GetType ( ) const

inline

To get with SetType changed values.

PVRSettingDefinition() [1/3]

kodi::addon::PVRSettingDefinition::PVRSettingDefinition ( unsigned int settingDefId, const std::string & settingDefName, PVR_SETTING_TYPE eType, uint64_t readonlyConditions, const PVRIntSettingDefinition & intSettingDef, const PVRStringSettingDefinition & stringSettingDef )

inline

Class constructor with integrated values.

Parameters

[in]	settingDefId	Setting definition identification value
[in]	settingDefName	Setting definition name
[in]	eType	Setting type
[in]	readonlyConditions	readonly conditions value
[in]	intSettingDef	int setting definition
[in]	stringSettingDef	string setting definition

PVRSettingDefinition() [2/3]

kodi::addon::PVRSettingDefinition::PVRSettingDefinition ( unsigned int settingDefId, const std::string & settingDefName, uint64_t readonlyConditions, const PVRIntSettingDefinition & settingDef )

inline

Class constructor with integrated values.

Parameters

[in]	settingDefId	Setting definition identification value
[in]	settingDefName	Setting definition name
[in]	readonlyConditions	readonly conditions value
[in]	settingDef	int setting definition

PVRSettingDefinition() [3/3]

kodi::addon::PVRSettingDefinition::PVRSettingDefinition ( unsigned int settingDefId, const std::string & settingDefName, uint64_t readonlyConditions, const PVRStringSettingDefinition & settingDef )

inline

Class constructor with integrated values.

Parameters

[in]	settingDefId	Setting definition identification value
[in]	settingDefName	Setting definition name
[in]	readonlyConditions	readonly conditions value
[in]	settingDef	string setting definition

SetId()

void kodi::addon::PVRSettingDefinition::SetId ( unsigned int defId )

inline

required
This setting definition's identifier.

SetIntDefinition()

void kodi::addon::PVRSettingDefinition::SetIntDefinition ( const PVRIntSettingDefinition & def )

inline

optional

Parameters

[in]

def

integer setting definition

---

SetName()

void kodi::addon::PVRSettingDefinition::SetName ( const std::string & name )

inline

required
A short localized string with the name of the setting.

SetReadonlyConditions()

void kodi::addon::PVRSettingDefinition::SetReadonlyConditions ( uint64_t conditions )

inline

optional
The read-only conditions value for this setting. PVR_SETTING_READONLY_CONDITION_* enum values

SetStringDefinition()

void kodi::addon::PVRSettingDefinition::SetStringDefinition ( const PVRStringSettingDefinition & def )

inline

optional

Parameters

[in]

def

string setting definition

---

SetType()

void kodi::addon::PVRSettingDefinition::SetType ( PVR_SETTING_TYPE eType )

inline

required
This setting definition's identifier.