Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
XBMCHelper Class Reference

#include <XBMCHelper.h>

Inheritance diagram for XBMCHelper:

Public Member Functions

bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting is being changed.
void Start ()
void Stop ()
void Configure ()
bool IsRunning ()
bool IsAlwaysOn () const
int GetMode () const
bool ErrorStarting ()
- Public Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
virtual void OnSettingChanged (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting has changed.
virtual void OnSettingAction (const std::shared_ptr< const CSetting > &setting)
 The given setting has been activated.
virtual bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
 The given setting needs to be updated.
virtual void OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
 The given property of the given setting has changed.

Static Public Member Functions

static XBMCHelperGetInstance ()

Member Function Documentation

◆ Configure()

void XBMCHelper::Configure ( )

◆ ErrorStarting()

bool XBMCHelper::ErrorStarting ( )

◆ GetInstance()

XBMCHelper & XBMCHelper::GetInstance ( )

◆ GetMode()

int XBMCHelper::GetMode ( ) const

◆ IsAlwaysOn()

bool XBMCHelper::IsAlwaysOn ( ) const

◆ IsRunning()

bool XBMCHelper::IsRunning ( )

◆ OnSettingChanging()

bool XBMCHelper::OnSettingChanging ( const std::shared_ptr< const CSetting > & setting)

The value of the given setting is being changed.

This callback is triggered whenever the value of a setting is being changed. The given CSetting already contains the new value and the handler of the callback has the possibility to allow or revert changing the value of the setting. In case of a revert OnSettingChanging() is called again to inform all listeners that the value change has been reverted.

settingThe setting whose value is being changed (already containing the changed value)
True if the new value is acceptable otherwise false

Reimplemented from ISettingCallback.

◆ Start()

void XBMCHelper::Start ( )

◆ Stop()

void XBMCHelper::Stop ( )

The documentation for this class was generated from the following files: