Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
ISettingCreator Class Referenceabstract

Interface for creating a new setting of a custom setting type. More...

#include <ISettingCreator.h>

Inheritance diagram for ISettingCreator:
CSettingCreator CSettingsManager ADDON::CAddonSettings CSettings

Public Member Functions

virtual ~ISettingCreator ()=default
 
virtual std::shared_ptr< CSettingCreateSetting (const std::string &settingType, const std::string &settingId, CSettingsManager *settingsManager=nullptr) const =0
 Creates a new setting of the given custom setting type.
 

Detailed Description

Interface for creating a new setting of a custom setting type.

Constructor & Destructor Documentation

◆ ~ISettingCreator()

virtual ISettingCreator::~ISettingCreator ( )
virtualdefault

Member Function Documentation

◆ CreateSetting()

virtual std::shared_ptr< CSetting > ISettingCreator::CreateSetting ( const std::string & settingType,
const std::string & settingId,
CSettingsManager * settingsManager = nullptr ) const
pure virtual

Creates a new setting of the given custom setting type.

Parameters
settingTypestring representation of the setting type
settingIdIdentifier of the setting to be created
settingsManagerReference to the settings manager
Returns
A new setting object of the given (custom) setting type or nullptr if the setting type is unknown

Implemented in ADDON::CAddonSettings, CSettingCreator, and CSettingsManager.


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