Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

Key-value pair of two ints
To hold a pair of two ints. More...

Topics

 Value Help
 

Classes

class  kodi::addon::PVRSettingKeyValuePair
 

Functions

 kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair ()=default
 Default class constructor.
 
 kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair (unsigned int key, int value)
 Class constructor with integrated value set.
 
 kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair (unsigned int key, const std::string &value)
 Class constructor with integrated value set.
 
 kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair (unsigned int key, PVR_SETTING_TYPE eType, int intValue, const std::string &stringValue)
 Class constructor with integrated value set.
 
void kodi::addon::PVRSettingKeyValuePair::SetKey (unsigned int key)
 To set with the key.
 
unsigned kodi::addon::PVRSettingKeyValuePair::GetKey () const
 To get with the key.
 
void kodi::addon::PVRSettingKeyValuePair::SetType (PVR_SETTING_TYPE eType)
 required
This key value pair's type.
 
PVR_SETTING_TYPE kodi::addon::PVRSettingKeyValuePair::GetType () const
 To get with SetType changed values.
 
void kodi::addon::PVRSettingKeyValuePair::SetIntValue (int value)
 To set with the value.
 
int kodi::addon::PVRSettingKeyValuePair::GetIntValue () const
 To get with the value.
 
void kodi::addon::PVRSettingKeyValuePair::SetStringValue (const std::string &value)
 To set with the value.
 
std::string kodi::addon::PVRSettingKeyValuePair::GetStringValue () const
 To get with the value.
 

Detailed Description

Key-value pair of two ints
To hold a pair of two ints.


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

Name Type Set call Get call
Key unsigned int SetKey GetKey

| Type | PVR_SETTING_TYPE | SetType | GetType | required to set | Int Value | int | SetIntValue | GetIntValue | String Value | std::string | SetStringValue | GetStringValue

Function Documentation

◆ GetIntValue()

int kodi::addon::PVRSettingKeyValuePair::GetIntValue ( ) const
inline

To get with the value.

◆ GetKey()

unsigned kodi::addon::PVRSettingKeyValuePair::GetKey ( ) const
inline

To get with the key.

◆ GetStringValue()

std::string kodi::addon::PVRSettingKeyValuePair::GetStringValue ( ) const
inline

To get with the value.

◆ GetType()

PVR_SETTING_TYPE kodi::addon::PVRSettingKeyValuePair::GetType ( ) const
inline

To get with SetType changed values.

◆ PVRSettingKeyValuePair() [1/4]

kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair ( )
default

Default class constructor.

◆ PVRSettingKeyValuePair() [2/4]

kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair ( unsigned int key,
const std::string & value )
inline

Class constructor with integrated value set.

Parameters
[in]keyThe key
[in]valueThe value

◆ PVRSettingKeyValuePair() [3/4]

kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair ( unsigned int key,
int value )
inline

Class constructor with integrated value set.

Parameters
[in]keyThe key
[in]valueThe value

◆ PVRSettingKeyValuePair() [4/4]

kodi::addon::PVRSettingKeyValuePair::PVRSettingKeyValuePair ( unsigned int key,
PVR_SETTING_TYPE eType,
int intValue,
const std::string & stringValue )
inline

Class constructor with integrated value set.

Parameters
[in]keyThe key
[in]eTypeThe type
[in]intValueThe int value
[in]stringValueThe string value

◆ SetIntValue()

void kodi::addon::PVRSettingKeyValuePair::SetIntValue ( int value)
inline

To set with the value.

◆ SetKey()

void kodi::addon::PVRSettingKeyValuePair::SetKey ( unsigned int key)
inline

To set with the key.

◆ SetStringValue()

void kodi::addon::PVRSettingKeyValuePair::SetStringValue ( const std::string & value)
inline

To set with the value.

◆ SetType()

void kodi::addon::PVRSettingKeyValuePair::SetType ( PVR_SETTING_TYPE eType)
inline

required
This key value pair's type.