Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CSettingDate Class Reference

#include <SettingDateTime.h>

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

Public Member Functions

 CSettingDate (const std::string &id, CSettingsManager *settingsManager=NULL)
 
 CSettingDate (const std::string &id, int label, const std::string &value, CSettingsManager *settingsManager=NULL)
 
 CSettingDate (const std::string &id, const CSettingDate &setting)
 
 ~CSettingDate () override=default
 
SettingPtr Clone (const std::string &id) const override
 
bool CheckValidity (const std::string &value) const override
 
CDateTime GetDate () const
 
bool SetDate (const CDateTime &date)
 
- 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
 
bool Deserialize (const TiXmlNode *node, bool update=false) override
 Deserializes the given XML node into the properties of the setting object. More...
 
bool FromString (const std::string &value) override
 
std::string ToString () const override
 
bool Equals (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)
 
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)
 
StringSettingOptions UpdateDynamicOptions ()
 
- 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
 
bool IsEnabled () 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 IsVisible () const override
 Whether the setting object is visible or hidden. More...
 
void OnSettingAction (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...
 
virtual ~ISetting ()=default
 
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. More...
 
virtual void SetRequirementsMet (bool requirementsMet)
 Sets whether the setting object meets all necessary requirements. More...
 

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 ISetting
static bool DeserializeIdentification (const TiXmlNode *node, std::string &identification)
 Deserializes the given XML node to retrieve a setting object's identifier. More...
 
- 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 (std::shared_ptr< const CSetting > setting) override
 The value of the given setting is being changed. More...
 
void OnSettingChanged (std::shared_ptr< const CSetting > setting) override
 The value of the given setting has changed. More...
 
bool OnSettingUpdate (std::shared_ptr< CSetting > setting, const char *oldSettingId, const TiXmlNode *oldSettingNode) override
 The given setting needs to be updated. More...
 
void OnSettingPropertyChanged (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 ()
 
- Protected Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
 
- Protected Attributes inherited from CSettingString
std::string m_value
 
std::string m_default
 
bool m_allowEmpty = false
 
TranslatableStringSettingOptions m_translatableOptions
 
StringSettingOptions m_options
 
std::string m_optionsFillerName
 
StringSettingOptionsFiller m_optionsFiller = nullptr
 
voidm_optionsFillerData = nullptr
 
StringSettingOptions m_dynamicOptions
 
- 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
 
- Protected Attributes inherited from ISetting
std::string m_id
 
CSettingsManagerm_settingsManager
 

Constructor & Destructor Documentation

◆ CSettingDate() [1/3]

CSettingDate::CSettingDate ( const std::string &  id,
CSettingsManager settingsManager = NULL 
)

◆ CSettingDate() [2/3]

CSettingDate::CSettingDate ( const std::string &  id,
int  label,
const std::string &  value,
CSettingsManager settingsManager = NULL 
)

◆ CSettingDate() [3/3]

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

◆ ~CSettingDate()

CSettingDate::~CSettingDate ( )
overridedefault

Member Function Documentation

◆ CheckValidity()

bool CSettingDate::CheckValidity ( const std::string &  value) const
overridevirtual

Reimplemented from CSettingString.

◆ Clone()

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

Reimplemented from CSettingString.

◆ GetDate()

CDateTime CSettingDate::GetDate ( ) const
inline

◆ SetDate()

bool CSettingDate::SetDate ( const CDateTime date)
inline

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