class PVRStringSettingDefinition

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

Classes
class	kodi::addon::PVRStringSettingDefinition

Functions
	kodi::addon::PVRStringSettingDefinition::PVRStringSettingDefinition (const std::vector< PVRTypeStringValue > &settingValues, const std::string &defaultValue, bool allowEmptyValue)
	Class constructor with integrated values.
void	kodi::addon::PVRStringSettingDefinition::SetValues (const std::vector< PVRTypeStringValue > &values, const std::string &defaultValue="")
	optional value definitions.
std::vector< PVRTypeStringValue >	kodi::addon::PVRStringSettingDefinition::GetValues () const
	To get with SetValues changed values.
void	kodi::addon::PVRStringSettingDefinition::SetDefaultValue (const std::string &defaultValue)
	optional The default value for this setting.
std::string	kodi::addon::PVRStringSettingDefinition::GetDefaultValue () const
	To get with SetDefaultValue changed values.
void	kodi::addon::PVRStringSettingDefinition::SetAllowEmptyValue (bool allowEmptyValue)
	optional The allow empty values flag for this setting.
bool	kodi::addon::PVRStringSettingDefinition::GetAllowEmptyValue () const
	To get with SetAllowEmptyValue changed values.

Detailed Description

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

---

Function Documentation

GetAllowEmptyValue()

bool kodi::addon::PVRStringSettingDefinition::GetAllowEmptyValue ( ) const

inline

To get with SetAllowEmptyValue changed values.

GetDefaultValue()

std::string kodi::addon::PVRStringSettingDefinition::GetDefaultValue ( ) const

inline

To get with SetDefaultValue changed values.

GetValues()

std::vector< PVRTypeStringValue > kodi::addon::PVRStringSettingDefinition::GetValues ( ) const

inline

To get with SetValues changed values.

PVRStringSettingDefinition()

kodi::addon::PVRStringSettingDefinition::PVRStringSettingDefinition ( const std::vector< PVRTypeStringValue > & settingValues, const std::string & defaultValue, bool allowEmptyValue )

inline

Class constructor with integrated values.

Parameters

[in]	settingValues	possible setting values
[in]	defaultValue	default setting value
[in]	allowEmptyValues	allow empty values flag

SetAllowEmptyValue()

void kodi::addon::PVRStringSettingDefinition::SetAllowEmptyValue ( bool allowEmptyValue )

inline

optional
The allow empty values flag for this setting.

SetDefaultValue()

void kodi::addon::PVRStringSettingDefinition::SetDefaultValue ( const std::string & defaultValue )

inline

optional
The default value for this setting.

SetValues()

void kodi::addon::PVRStringSettingDefinition::SetValues ( const std::vector< PVRTypeStringValue > & values, const std::string & defaultValue = "" )

inline

optional
value definitions.

Array containing the possible settings values. If left blank, any string 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 PVRTypeStringValue :

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

Remarks

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