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

PVR add-on type value
Representation of a <int, std::string> event related value. More...

Topics

 Value Help
 

Classes

class  kodi::addon::PVRTypeIntValue
 

Functions

 kodi::addon::PVRTypeIntValue::PVRTypeIntValue ()=default
 Default class constructor.
 
 kodi::addon::PVRTypeIntValue::PVRTypeIntValue (int value, const std::string &description)
 Class constructor with integrated value set.
 
void kodi::addon::PVRTypeIntValue::SetValue (int value)
 To set with the identification value.
 
int kodi::addon::PVRTypeIntValue::GetValue () const
 To get with the identification value.
 
void kodi::addon::PVRTypeIntValue::SetDescription (const std::string &description)
 To set with the description text of the value.
 
std::string kodi::addon::PVRTypeIntValue::GetDescription () const
 To get with the description text of the value.
 

Detailed Description

PVR add-on type value
Representation of a <int, std::string> event related value.


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.

Function Documentation

◆ GetDescription()

std::string kodi::addon::PVRTypeIntValue::GetDescription ( ) const
inline

To get with the description text of the value.

◆ GetValue()

int kodi::addon::PVRTypeIntValue::GetValue ( ) const
inline

To get with the identification value.

◆ PVRTypeIntValue() [1/2]

kodi::addon::PVRTypeIntValue::PVRTypeIntValue ( )
default

Default class constructor.

Note
Values must be set afterwards.

◆ PVRTypeIntValue() [2/2]

kodi::addon::PVRTypeIntValue::PVRTypeIntValue ( int value,
const std::string & description )
inline

Class constructor with integrated value set.

Parameters
[in]valueType identification value
[in]descriptionType description text

◆ SetDescription()

void kodi::addon::PVRTypeIntValue::SetDescription ( const std::string & description)
inline

To set with the description text of the value.

◆ SetValue()

void kodi::addon::PVRTypeIntValue::SetValue ( int value)
inline

To set with the identification value.