ISettingCallback Class Reference

#include <ISettingCallback.h>

Inheritance diagram for ISettingCallback:

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

The given setting has been activated.

This callback is triggered whenever the given setting has been activated. This callback is only fired for CSettingAction settings.

Parameters

setting

The setting which has been activated.

Reimplemented in ADDON::CAddonSettings, ADDON::CAddonSystemSettings, CApplicationSettingsHandling, CDisplaySettings, CGUIDialogAddonSettings, CGUIDialogAudioSettings, CGUIDialogContentSettings, CGUIDialogInfoProviderSettings, CGUIDialogLibExportSettings, CGUIDialogLockSettings, CGUIDialogNetworkSetup, CGUIDialogProfileSettings, CGUIDialogSubtitleSettings, CGUIDialogVideoSettings, CGUIPassword, CMediaSettings, CProfileManager, CRssManager, CSetting, CWeatherManager, DebugLogSharingPresenter, PERIPHERALS::CPeripherals, PVR::CGUIDialogPVRTimerSettings, and PVR::CPVRGUIActionListener.

OnSettingChanged()

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

inlinevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters

setting

The setting whose value has been changed

Reimplemented in ActiveAE::CActiveAESettings, ADDON::CAddonSystemSettings, ADDON::CRepositoryUpdater, CAdvancedSettings, CAndroidUtils, CApplicationSettingsHandling, CCharsetConverter, CDiscSettings, CDisplaySettings, CGUIAudioManager, CGUIDialogAudioSettings, CGUIDialogCMSSettings, CGUIDialogContentSettings, CGUIDialogInfoProviderSettings, CGUIDialogLibExportSettings, CGUIDialogLockSettings, CGUIDialogMediaFilter, CGUIDialogNetworkSetup, CGUIDialogProfileSettings, CGUIDialogSettingsBase, CGUIDialogSubtitleSettings, CGUIDialogVideoSettings, CInputManager, CLangInfo, CLibInputSettings, CLog, CMediaSettings, CNetworkServices, CSeekHandler, CSetting, CStereoscopicsManager, CTVOSInputSettings, CWakeOnAccess, CWeatherManager, KODI::GAME::CGameSettings, KODI::SUBTITLES::CSubtitlesSettings, PERIPHERALS::CGUIDialogPeripheralSettings, PERIPHERALS::CPeripherals, PVR::CGUIDialogPVRClientPriorities, PVR::CGUIDialogPVRRecordingSettings, PVR::CGUIDialogPVRTimerSettings, PVR::CPVRChannelGroups, PVR::CPVRChannelGroupSettings, PVR::CPVRGUIActionListener, and PVR::CPVRSettings.

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

setting

The 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

setting	The setting which has a changed property
propertyName	The 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

setting	The setting which needs to be updated.
oldSettingId	The id of the previous setting.
oldSettingNode	The 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:

• ISettingCallback.h