class PVRIntSettingDefinition

PVR add-on integer setting definition
Representation of an integer setting definition. More...

Classes
class	kodi::addon::PVRIntSettingDefinition

Functions
	kodi::addon::PVRIntSettingDefinition::PVRIntSettingDefinition (const std::vector< PVRTypeIntValue > &settingValues, int defaultValue, int minValue, int step, int maxValue)
	Class constructor with integrated values.
void	kodi::addon::PVRIntSettingDefinition::SetValues (const std::vector< PVRTypeIntValue > &values, int defaultValue=-1)
	optional value definitions.
std::vector< PVRTypeIntValue >	kodi::addon::PVRIntSettingDefinition::GetValues () const
	To get with SetValues changed values.
void	kodi::addon::PVRIntSettingDefinition::SetDefaultValue (int defaultValue)
	optional The default value for this setting.
int	kodi::addon::PVRIntSettingDefinition::GetDefaultValue () const
	To get with SetDefaultValue changed values.
void	kodi::addon::PVRIntSettingDefinition::SetMinValue (int minValue)
	optional The minimum value for this setting.
int	kodi::addon::PVRIntSettingDefinition::GetMinValue () const
	To get with SetMinValue changed values.
void	kodi::addon::PVRIntSettingDefinition::SetStep (int step)
	optional The amount for increasing the values for this setting from min to max.
int	kodi::addon::PVRIntSettingDefinition::GetStep () const
	To get with SetStep changed values.
void	kodi::addon::PVRIntSettingDefinition::SetMaxValue (int maxValue)
	optional The maximum value for this setting.
int	kodi::addon::PVRIntSettingDefinition::GetMaxValue () const
	To get with SetMaxValue changed values.

Detailed Description

PVR add-on integer setting definition
Representation of an integer setting definition.

---

Function Documentation

GetDefaultValue()

int kodi::addon::PVRIntSettingDefinition::GetDefaultValue ( ) const

inline

To get with SetDefaultValue changed values.

GetMaxValue()

int kodi::addon::PVRIntSettingDefinition::GetMaxValue ( ) const

inline

To get with SetMaxValue changed values.

GetMinValue()

int kodi::addon::PVRIntSettingDefinition::GetMinValue ( ) const

inline

To get with SetMinValue changed values.

GetStep()

int kodi::addon::PVRIntSettingDefinition::GetStep ( ) const

inline

To get with SetStep changed values.

GetValues()

std::vector< PVRTypeIntValue > kodi::addon::PVRIntSettingDefinition::GetValues ( ) const

inline

To get with SetValues changed values.

PVRIntSettingDefinition()

kodi::addon::PVRIntSettingDefinition::PVRIntSettingDefinition ( const std::vector< PVRTypeIntValue > & settingValues, int defaultValue, int minValue, int step, int maxValue )

inline

Class constructor with integrated values.

Parameters

[in]	settingValues	possible setting values
[in]	defaultValue	default setting value
[in]	minValue	minimim setting value
[in]	step	amount to change values from min to max
[in]	maxValue	maximum setting value

SetDefaultValue()

void kodi::addon::PVRIntSettingDefinition::SetDefaultValue ( int defaultValue )

inline

optional
The default value for this setting.

SetMaxValue()

void kodi::addon::PVRIntSettingDefinition::SetMaxValue ( int maxValue )

inline

optional
The maximum value for this setting.

SetMinValue()

void kodi::addon::PVRIntSettingDefinition::SetMinValue ( int minValue )

inline

optional
The minimum value for this setting.

SetStep()

void kodi::addon::PVRIntSettingDefinition::SetStep ( int step )

inline

optional
The amount for increasing the values for this setting from min to max.

SetValues()

void kodi::addon::PVRIntSettingDefinition::SetValues ( const std::vector< PVRTypeIntValue > & values, int defaultValue = -1 )

inline

optional
value definitions.

Array containing the possible settings values. If left blank, any int value is accepted.

Parameters

[in]	values	List of possible values
[in]	defaultValue	[opt] The default value in list, can also be set by SetDefaultValue()

---

The following table contains values that can be set with class PVRTypeIntValue :

Name	Type	Set call	Get call
Value	int	SetValue	GetValue
Description	std::string	SetDescription	GetDescription

Remarks

Further can there be used his class constructor to set values.