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

Interface defining methods to load additional setting values from an XML file being loaded by the settings system. More...

#include <ISubSettings.h>

Inheritance diagram for ISubSettings:
CApplicationSettingsHandling CDisplaySettings CMediaSettings CPlayerSettings CServicesSettings CSettings CSkinSettings CSysInfo CViewStateSettings

Public Member Functions

virtual ~ISubSettings ()=default
 
virtual bool Load (const TiXmlNode *settings)
 Load settings from the given XML node.
 
virtual bool Save (TiXmlNode *settings) const
 Save settings to the given XML node.
 
virtual void Clear ()
 Clear any loaded setting values.
 

Detailed Description

Interface defining methods to load additional setting values from an XML file being loaded by the settings system.

Constructor & Destructor Documentation

◆ ~ISubSettings()

virtual ISubSettings::~ISubSettings ( )
virtualdefault

Member Function Documentation

◆ Clear()

virtual void ISubSettings::Clear ( )
inlinevirtual

Clear any loaded setting values.

Reimplemented in CDisplaySettings, CSettings, CSkinSettings, and CViewStateSettings.

◆ Load()

virtual bool ISubSettings::Load ( const TiXmlNode * settings)
inlinevirtual

Load settings from the given XML node.

Parameters
settingsXML node containing setting values
Returns
True if loading the settings was successful, false otherwise.

Reimplemented in CApplicationSettingsHandling, CDisplaySettings, CMediaSettings, CSkinSettings, CSysInfo, and CViewStateSettings.

◆ Save()

virtual bool ISubSettings::Save ( TiXmlNode * settings) const
inlinevirtual

Save settings to the given XML node.

Parameters
settingsXML node in which the settings will be saved
Returns
True if saving the settings was successful, false otherwise.

Reimplemented in CApplicationSettingsHandling, CDisplaySettings, CMediaSettings, CSettings, CSkinSettings, CSysInfo, and CViewStateSettings.


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