Detailed Description

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

Function Documentation

◆ PVRSettingDefinition() [1/3]

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() [2/3]

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

◆ PVRSettingDefinition() [3/3]

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

◆ SetId()

void SetId ( unsigned int defId )

inline

required
This setting definition's identifier.

◆ GetId()

unsigned int GetId ( ) const

inline

To get with SetId changed values.

◆ SetName()

void SetName ( const std::string & name )

inline

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

◆ GetName()

std::string GetName ( ) const

inline

To get with SetName changed values.

◆ SetType()

void SetType ( PVR_SETTING_TYPE eType )

inline

required
This setting definition's identifier.

◆ GetType()

PVR_SETTING_TYPE GetType ( ) const

inline

To get with SetType changed values.

◆ SetReadonlyConditions()

void SetReadonlyConditions ( uint64_t conditions )

inline

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

◆ GetReadonlyConditions()

uint64_t GetReadonlyConditions ( ) const

inline

To get with SetReadonlyConditions changed values.

◆ SetIntDefinition()

void SetIntDefinition ( const PVRIntSettingDefinition & def )

inline

optional

Parameters

[in] def integer setting definition

◆ GetIntDefinition()

PVRIntSettingDefinition GetIntDefinition ( ) const

inline

To get with SetIntDefinition changed values.

◆ SetStringDefinition()

void SetStringDefinition ( const PVRStringSettingDefinition & def )

inline

optional

Parameters

[in] def string setting definition

◆ GetStringDefinition()

PVRStringSettingDefinition GetStringDefinition ( ) const

inline

To get with SetStringDefinition changed values.