ISettingsHandler Class Reference

Interface defining methods being called by the settings system if an action is performed on multiple/all settings. More...

#include <ISettingsHandler.h>

Inheritance diagram for ISettingsHandler:

Public Member Functions
virtual	~ISettingsHandler ()=default
virtual bool	OnSettingsLoading ()
	Settings loading has been initiated.
virtual void	OnSettingsLoaded ()
	Settings have been loaded.
virtual bool	OnSettingsSaving () const
	Settings saving has been initiated.
virtual void	OnSettingsSaved () const
	Settings have been saved.
virtual void	OnSettingsUnloaded ()
	Setting values have been unloaded.
virtual void	OnSettingsCleared ()
	Settings have been cleared.

Detailed Description

Interface defining methods being called by the settings system if an action is performed on multiple/all settings.

Constructor & Destructor Documentation

~ISettingsHandler()

virtual ISettingsHandler::~ISettingsHandler ( )

virtualdefault

Member Function Documentation

OnSettingsCleared()

virtual void ISettingsHandler::OnSettingsCleared ( )

inlinevirtual

Settings have been cleared.

This callback can be used to trigger clearing any state variables.

Reimplemented in CProfileManager.

OnSettingsLoaded()

virtual void ISettingsHandler::OnSettingsLoaded ( )

inlinevirtual

Settings have been loaded.

This callback can be used to trigger loading other settings.

Reimplemented in CPlayerCoreFactory, CLangInfo, CWakeOnAccess, CProfileManager, PVR::CPVRSettings, CAdvancedSettings, CMediaSourceSettings, CLog, and CRssManager.

OnSettingsLoading()

virtual bool ISettingsHandler::OnSettingsLoading ( )

inlinevirtual

Settings loading has been initiated.

Returns

True if the settings should be loaded, false if the loading should be aborted.

OnSettingsSaved()

virtual void ISettingsHandler::OnSettingsSaved ( ) const

inlinevirtual

Settings have been saved.

This callback can be used to trigger saving other settings.

Reimplemented in CProfileManager.

OnSettingsSaving()

virtual bool ISettingsHandler::OnSettingsSaving ( ) const

inlinevirtual

Settings saving has been initiated.

Returns

True if the settings should be saved, false if the saving should be aborted.

Reimplemented in CApplication.

OnSettingsUnloaded()

virtual void ISettingsHandler::OnSettingsUnloaded ( )

inlinevirtual

Setting values have been unloaded.

This callback can be used to trigger uninitializing any state variables (e.g. before re-loading the settings).

Reimplemented in CUPnPSettings, CAdvancedSettings, CMediaSourceSettings, and CRssManager.

---

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

• ISettingsHandler.h