List setting implementation. More...
#include <Setting.h>
Inheritance diagram for CSettingList:
Collaboration diagram for CSettingList:
Public Member Functions | |
| CSettingList (const std::string &id, std::shared_ptr< CSetting > settingDefinition, CSettingsManager *settingsManager=nullptr) | |
| CSettingList (const std::string &id, std::shared_ptr< CSetting > settingDefinition, int label, CSettingsManager *settingsManager=nullptr) | |
| CSettingList (const std::string &id, const CSettingList &setting) | |
| std::shared_ptr< CSetting > | Clone (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. More... | |
| SettingType | GetType () const override |
| 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 |
| SettingType | GetElementType () const |
| std::shared_ptr< CSetting > | GetDefinition () |
| std::shared_ptr< const CSetting > | GetDefinition () const |
| void | SetDefinition (std::shared_ptr< CSetting > definition) |
| const std::string & | GetDelimiter () const |
| void | SetDelimiter (const std::string &delimiter) |
| int | GetMinimumItems () const |
| void | SetMinimumItems (int minimumItems) |
| int | GetMaximumItems () const |
| void | SetMaximumItems (int maximumItems) |
| bool | FromString (const std::vector< std::string > &value) |
| const SettingList & | GetValue () const |
| bool | SetValue (const SettingList &values) |
| const SettingList & | GetDefault () const |
| void | SetDefault (const SettingList &values) |
 Public Member Functions inherited from CSetting | |
| CSetting (const std::string &id, CSettingsManager *settingsManager=nullptr) | |
| CSetting (const std::string &id, const CSetting &setting) | |
| 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 ISettingControl > | GetControl () const |
| std::shared_ptr< ISettingControl > | GetControl () |
| void | SetControl (std::shared_ptr< ISettingControl > control) |
| const SettingDependencies & | GetDependencies () 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. More... | |
| void | OnSettingAction (const std::shared_ptr< const CSetting > &setting) override |
| The given setting has been activated. More... | |
| Public Member Functions inherited from ISetting | |
| ISetting (const std::string &id, CSettingsManager *settingsManager=nullptr) | |
| Creates a new setting object with the given identifier. More... | |
| const std::string & | GetId () const |
| Gets the identifier of the setting object. More... | |
| virtual void | SetVisible (bool visible) |
| Sets the visibility state of the setting object. More... | |
| int | GetLabel () const |
| Gets the localizeable label ID of the setting group. More... | |
| void | SetLabel (int label) |
| Sets the localizeable label ID of the setting group. More... | |
| int | GetHelp () const |
| Gets the localizeable help ID of the setting group. More... | |
| void | SetHelp (int help) |
| Sets the localizeable help ID of the setting group. More... | |
| virtual bool | MeetsRequirements () const |
| Whether the setting object meets all necessary requirements. More... | |
| 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. More... | |
Protected Member Functions | |
| void | copy (const CSettingList &setting) |
| bool | fromString (const std::string &strValue, SettingList &values) const |
| bool | fromValues (const std::vector< std::string > &strValues, SettingList &values) const |
| std::string | toString (const SettingList &values) const |
| 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. More... | |
| void | OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override |
| The value of the given setting has changed. More... | |
| bool | OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode) override |
| The given setting needs to be updated. More... | |
| void | OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName) override |
| The given property of the given setting has changed. More... | |
| void | Copy (const CSetting &setting) |
| template<class TSetting > | |
| std::shared_ptr< TSetting > | shared_from_base () |
Static Protected Member Functions | |
| static void | copy (const SettingList &srcValues, SettingList &dstValues) |
| 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. More... | |
Protected Attributes | |
| SettingList | m_values |
| SettingList | m_defaults |
| std::shared_ptr< CSetting > | m_definition |
| std::string | m_delimiter = "|" |
| int | m_minimumItems = 0 |
| int | m_maximumItems = -1 |
| Protected Attributes inherited from CSetting | |
| ISettingCallback * | m_callback = nullptr |
| bool | m_enabled = true |
| std::string | m_parentSetting |
| SettingLevel | m_level = SettingLevel::Standard |
| std::shared_ptr< ISettingControl > | m_control |
| SettingDependencies | m_dependencies |
| std::set< CSettingUpdate > | m_updates |
| bool | m_changed = false |
| CSharedSection | m_critical |
| std::string | m_referencedId |
| Protected Attributes inherited from ISetting | |
| std::string | m_id |
| CSettingsManager * | m_settingsManager |
Static Protected Attributes | |
| static Logger | s_logger |
| Static Protected Attributes inherited from ISetting | |
| static constexpr int | DefaultLabel = -1 |
Additional Inherited Members | |
| 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. More... | |
| 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. More... | |
Detailed Description
List setting implementation.
- See also
- CSetting
Member Function Documentation
◆ Deserialize()
|
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
-
node XML node containing the properties of the setting object update Whether to perform checks for mandatory properties or not
- Returns
- True if deserialization was successful, false otherwise
Reimplemented from CSetting.
The documentation for this class was generated from the following files:
- xbmc/settings/lib/Setting.h
- xbmc/settings/lib/Setting.cpp
