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

#include <SettingAddon.h>

Inheritance diagram for CSettingAddon:
CSettingString CTraitedSetting< std::string, SettingType::String > CSetting ISetting ISettingCallback

Public Member Functions

 CSettingAddon (const std::string &id, CSettingsManager *settingsManager=nullptr)
 
 CSettingAddon (const std::string &id, int label, const std::string &value, CSettingsManager *settingsManager=nullptr)
 
 CSettingAddon (const std::string &id, const CSettingAddon &setting)
 
 ~CSettingAddon () override=default
 
SettingPtr Clone (const std::string &id) const override
 
bool Deserialize (const TiXmlNode *node, bool update=false) override
 Deserializes the given XML node into the properties of the setting object.
 
ADDON::AddonType GetAddonType () const
 
void SetAddonType (ADDON::AddonType addonType)
 
- Public Member Functions inherited from CSettingString
 CSettingString (const std::string &id, CSettingsManager *settingsManager=nullptr)
 
 CSettingString (const std::string &id, const CSettingString &setting)
 
 CSettingString (const std::string &id, int label, const std::string &value, CSettingsManager *settingsManager=nullptr)
 
 ~CSettingString () override=default
 
std::shared_ptr< CSettingClone (const std::string &id) const override
 
void MergeDetails (const CSetting &other) override
 
bool Deserialize (const TiXmlNode *node, bool update=false) override
 Deserializes the given XML node into the properties of the setting object.
 
bool FromString (const std::string &value) override
 
std::string ToString () const override
 
bool Equals (const std::string &value) const override
 
bool CheckValidity (const std::string &value) const override
 
void Reset () override
 
virtual const std::string & GetValue () const
 
virtual bool SetValue (const std::string &value)
 
virtual const std::string & GetDefault () const
 
virtual void SetDefault (const std::string &value)
 
virtual bool AllowEmpty () const
 
void SetAllowEmpty (bool allowEmpty)
 
virtual bool AllowNewOption () const
 
void SetAllowNewOption (bool allowNewOption)
 
SettingOptionsType GetOptionsType () const
 
const TranslatableStringSettingOptionsGetTranslatableOptions () const
 
void SetTranslatableOptions (const TranslatableStringSettingOptions &options)
 
const StringSettingOptionsGetOptions () const
 
void SetOptions (const StringSettingOptions &options)
 
const std::string & GetOptionsFillerName () const
 
void SetOptionsFillerName (const std::string &optionsFillerName, void *data=nullptr)
 
void SetOptionsFiller (StringSettingOptionsFiller optionsFiller, void *data=nullptr)
 
const StringSettingOptionsGetDynamicOptions () const
 
StringSettingOptions UpdateDynamicOptions ()
 
SettingOptionsSort GetOptionsSort () const
 
void SetOptionsSort (SettingOptionsSort optionsSort)
 
- Public Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
SettingType GetType () const override
 
- Public Member Functions inherited from CSetting
 CSetting (const std::string &id, CSettingsManager *settingsManager=nullptr)
 
 CSetting (const std::string &id, const CSetting &setting)
 
 ~CSetting () override=default
 
void MergeBasics (const CSetting &other)
 
bool IsEnabled () const
 
bool GetEnabled () const
 
void SetEnabled (bool enabled)
 
bool IsDefault () const
 
const std::string & GetParent () const
 
void SetParent (const std::string &parentSetting)
 
SettingLevel GetLevel () const
 
void SetLevel (SettingLevel level)
 
std::shared_ptr< const ISettingControlGetControl () const
 
std::shared_ptr< ISettingControlGetControl ()
 
void SetControl (std::shared_ptr< ISettingControl > control)
 
const SettingDependenciesGetDependencies () const
 
void SetDependencies (const SettingDependencies &dependencies)
 
const std::set< CSettingUpdate > & GetUpdates () const
 
void SetCallback (ISettingCallback *callback)
 
bool IsReference () const
 
const std::string & GetReferencedId () const
 
void SetReferencedId (const std::string &referencedId)
 
void MakeReference (const std::string &referencedId="")
 
bool GetVisible () const
 
bool IsVisible () const override
 Whether the setting object is visible or hidden.
 
void OnSettingAction (const std::shared_ptr< const CSetting > &setting) override
 The given setting has been activated.
 
- Public Member Functions inherited from ISetting
 ISetting (const std::string &id, CSettingsManager *settingsManager=nullptr)
 Creates a new setting object with the given identifier.
 
virtual ~ISetting ()=default
 
const std::string & GetId () const
 Gets the identifier of the setting object.
 
virtual void SetVisible (bool visible)
 Sets the visibility state of the setting object.
 
int GetLabel () const
 Gets the localizeable label ID of the setting group.
 
void SetLabel (int label)
 Sets the localizeable label ID of the setting group.
 
int GetHelp () const
 Gets the localizeable help ID of the setting group.
 
void SetHelp (int help)
 Sets the localizeable help ID of the setting group.
 
virtual bool MeetsRequirements () const
 Whether the setting object meets all necessary requirements.
 
virtual void CheckRequirements ()
 Checks if the setting object meets all necessary requirements.
 
virtual void SetRequirementsMet (bool requirementsMet)
 Sets whether the setting object meets all necessary requirements.
 

Additional Inherited Members

- Public Types inherited from CTraitedSetting< std::string, SettingType::String >
typedef std::string Value
 
- Static Public Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
static SettingType Type ()
 
- Static Public Member Functions inherited from CSetting
static bool DeserializeIdentification (const TiXmlNode *node, std::string &identification, bool &isReference)
 Deserializes the given XML node to retrieve a setting object's identifier and whether the setting is a reference to another setting or not.
 
- Static Public Member Functions inherited from ISetting
static bool DeserializeIdentification (const TiXmlNode *node, std::string &identification)
 Deserializes the given XML node to retrieve a setting object's identifier.
 
- Protected Member Functions inherited from CSettingString
virtual void copy (const CSettingString &setting)
 
- Protected Member Functions inherited from CTraitedSetting< std::string, SettingType::String >
 CTraitedSetting (const std::string &id, CSettingsManager *settingsManager=nullptr)
 
 CTraitedSetting (const std::string &id, const CTraitedSetting &setting)
 
 ~CTraitedSetting () override=default
 
- Protected Member Functions inherited from CSetting
bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting is being changed.
 
void OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting has changed.
 
bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode) override
 The given setting needs to be updated.
 
void OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName) override
 The given property of the given setting has changed.
 
void Copy (const CSetting &setting)
 
template<class TSetting >
std::shared_ptr< TSetting > shared_from_base ()
 
- Protected Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
 
- Static Protected Member Functions inherited from ISetting
static bool DeserializeIdentificationFromAttribute (const TiXmlNode *node, const std::string &attribute, std::string &identification)
 Deserializes the given XML node to retrieve a setting object's identifier from the given attribute.
 
- Protected Attributes inherited from CSettingString
std::string m_value
 
std::string m_default
 
bool m_allowEmpty = false
 
bool m_allowNewOption = false
 
TranslatableStringSettingOptions m_translatableOptions
 
StringSettingOptions m_options
 
std::string m_optionsFillerName
 
StringSettingOptionsFiller m_optionsFiller = nullptr
 
voidm_optionsFillerData = nullptr
 
StringSettingOptions m_dynamicOptions
 
SettingOptionsSort m_optionsSort = SettingOptionsSort::NoSorting
 
- Protected Attributes inherited from CSetting
ISettingCallbackm_callback = nullptr
 
bool m_enabled = true
 
std::string m_parentSetting
 
SettingLevel m_level = SettingLevel::Standard
 
std::shared_ptr< ISettingControlm_control
 
SettingDependencies m_dependencies
 
std::set< CSettingUpdatem_updates
 
bool m_changed = false
 
CSharedSection m_critical
 
std::string m_referencedId
 
- Protected Attributes inherited from ISetting
std::string m_id
 
CSettingsManagerm_settingsManager
 
- Static Protected Attributes inherited from CSettingString
static const Value DefaultValue
 
static Logger s_logger
 
- Static Protected Attributes inherited from ISetting
static constexpr int DefaultLabel = -1
 

Constructor & Destructor Documentation

◆ CSettingAddon() [1/3]

CSettingAddon::CSettingAddon ( const std::string & id,
CSettingsManager * settingsManager = nullptr )

◆ CSettingAddon() [2/3]

CSettingAddon::CSettingAddon ( const std::string & id,
int label,
const std::string & value,
CSettingsManager * settingsManager = nullptr )

◆ CSettingAddon() [3/3]

CSettingAddon::CSettingAddon ( const std::string & id,
const CSettingAddon & setting )

◆ ~CSettingAddon()

CSettingAddon::~CSettingAddon ( )
overridedefault

Member Function Documentation

◆ Clone()

SettingPtr CSettingAddon::Clone ( const std::string & id) const
overridevirtual

Implements CSetting.

◆ Deserialize()

bool CSettingAddon::Deserialize ( const TiXmlNode * node,
bool update = false )
overridevirtual

Deserializes the given XML node into the properties of the setting object.

If the update parameter is true, the checks for mandatory properties are skipped and values are only updated.

Parameters
nodeXML node containing the properties of the setting object
updateWhether to perform checks for mandatory properties or not
Returns
True if deserialization was successful, false otherwise

Reimplemented from CSetting.

◆ GetAddonType()

ADDON::AddonType CSettingAddon::GetAddonType ( ) const
inline

◆ SetAddonType()

void CSettingAddon::SetAddonType ( ADDON::AddonType addonType)
inline

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