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

#include <ISettingCallback.h>

Inheritance diagram for ISettingCallback:
ADDON::CAddonSettings ADDON::CAddonSystemSettings ADDON::CRepositoryUpdater ActiveAE::CActiveAESettings CAdvancedSettings CAndroidUtils CApplicationSettingsHandling CCharsetConverter CDiscSettings CDisplaySettings CGUIAudioManager CGUIDialogSettingsBase CGUIPassword CInputManager CLangInfo CLibInputSettings CLog CMediaSettings CNetworkServices CProfileManager CRssManager CSeekHandler CSetting CSettingsManager CStereoscopicsManager CTVOSInputSettings CWakeOnAccess CWeatherManager DebugLogSharingPresenter KODI::GAME::CGameSettings KODI::SUBTITLES::CSubtitlesSettings PERIPHERALS::CPeripherals PVR::CPVRChannelGroupSettings PVR::CPVRChannelGroups PVR::CPVRGUIActionListener PVR::CPVRSettings XBMCHelper

Public Member Functions

virtual ~ISettingCallback ()=default
 
virtual bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting is being changed.
 
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.
 

Constructor & Destructor Documentation

◆ ~ISettingCallback()

virtual ISettingCallback::~ISettingCallback ( )
virtualdefault

Member Function Documentation

◆ OnSettingAction()

virtual void ISettingCallback::OnSettingAction ( const std::shared_ptr< const CSetting > & setting)
inlinevirtual

◆ OnSettingChanged()

◆ OnSettingChanging()

virtual bool ISettingCallback::OnSettingChanging ( const std::shared_ptr< const CSetting > & setting)
inlinevirtual

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.

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

Reimplemented in CDisplaySettings, CNetworkServices, CSetting, PVR::CGUIDialogPVRRecordingSettings, and XBMCHelper.

◆ OnSettingPropertyChanged()

virtual void ISettingCallback::OnSettingPropertyChanged ( const std::shared_ptr< const CSetting > & setting,
const char * propertyName )
inlinevirtual

The given property of the given setting has changed.

This callback is triggered when a property (e.g. enabled or the list of dynamic options) has changed.

Parameters
settingThe setting which has a changed property
propertyNameThe string representation of the changed property

Reimplemented in CGUIDialogSettingsBase, and CSetting.

◆ OnSettingUpdate()

virtual bool ISettingCallback::OnSettingUpdate ( const std::shared_ptr< CSetting > & setting,
const char * oldSettingId,
const TiXmlNode * oldSettingNode )
inlinevirtual

The given setting needs to be updated.

This callback is triggered when a setting needs to be updated because its value is outdated. This only happens when initially loading the value of a setting and will not be triggered afterwards.

Parameters
settingThe setting which needs to be updated.
oldSettingIdThe id of the previous setting.
oldSettingNodeThe old setting node
Returns
True if the setting has been successfully updated otherwise false

Reimplemented in CApplicationSettingsHandling, CDisplaySettings, CGUIAudioManager, CNetworkServices, and CSetting.


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