xbmc
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
CMediaSettings Class Reference
Inheritance diagram for CMediaSettings:
Inheritance graph
[legend]
Collaboration diagram for CMediaSettings:
Collaboration graph
[legend]

Public Member Functions

bool Load (const TiXmlNode *settings) override
 Load settings from the given XML node. More...
 
bool Save (TiXmlNode *settings) const override
 Save settings to the given XML node. More...
 
void OnSettingAction (const std::shared_ptr< const CSetting > &setting) override
 The given setting has been activated. More...
 
void OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting has changed. More...
 
const CVideoSettingsGetDefaultVideoSettings () const
 
CVideoSettingsGetDefaultVideoSettings ()
 
const CGameSettingsGetDefaultGameSettings () const
 
CGameSettingsGetDefaultGameSettings ()
 
const CGameSettingsGetCurrentGameSettings () const
 
CGameSettingsGetCurrentGameSettings ()
 
int GetWatchedMode (const std::string &content) const
 Retrieve the watched mode for the given content type. More...
 
void SetWatchedMode (const std::string &content, WatchedMode mode)
 Set the watched mode for the given content type. More...
 
void CycleWatchedMode (const std::string &content)
 Cycle the watched mode for the given content type. More...
 
void SetMusicPlaylistRepeat (bool repeats)
 
void SetMusicPlaylistShuffled (bool shuffled)
 
void SetVideoPlaylistRepeat (bool repeats)
 
void SetVideoPlaylistShuffled (bool shuffled)
 
bool DoesMediaStartWindowed () const
 
void SetMediaStartWindowed (bool windowed)
 
int GetAdditionalSubtitleDirectoryChecked () const
 
void SetAdditionalSubtitleDirectoryChecked (int checked)
 
int GetMusicNeedsUpdate () const
 
void SetMusicNeedsUpdate (int version)
 
int GetVideoNeedsUpdate () const
 
void SetVideoNeedsUpdate (int version)
 
- Public Member Functions inherited from ISettingCallback
virtual bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting is being changed. More...
 
virtual bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
 The given setting needs to be updated. More...
 
virtual void OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
 The given property of the given setting has changed. More...
 
- Public Member Functions inherited from ISettingsHandler
virtual bool OnSettingsLoading ()
 Settings loading has been initiated. More...
 
virtual void OnSettingsLoaded ()
 Settings have been loaded. More...
 
virtual bool OnSettingsSaving () const
 Settings saving has been initiated. More...
 
virtual void OnSettingsSaved () const
 Settings have been saved. More...
 
virtual void OnSettingsUnloaded ()
 Setting values have been unloaded. More...
 
virtual void OnSettingsCleared ()
 Settings have been cleared. More...
 
- Public Member Functions inherited from ISubSettings
virtual void Clear ()
 Clear any loaded setting values.
 

Static Public Member Functions

static CMediaSettingsGetInstance ()
 

Protected Member Functions

 CMediaSettings (const CMediaSettings &)=delete
 
CMediaSettingsoperator= (CMediaSettings const &)=delete
 

Static Protected Member Functions

static std::string GetWatchedContent (const std::string &content)
 

Member Function Documentation

◆ CycleWatchedMode()

void CMediaSettings::CycleWatchedMode ( const std::string &  content)

Cycle the watched mode for the given content type.

Parameters
contentCurrent content type
See also
GetWatchMode, SetWatchMode

◆ GetWatchedMode()

int CMediaSettings::GetWatchedMode ( const std::string &  content) const

Retrieve the watched mode for the given content type.

Parameters
contentCurrent content type
Returns
the current watch mode for this content type, WATCH_MODE_ALL if the content type is unknown.
See also
SetWatchMode

◆ Load()

bool CMediaSettings::Load ( const TiXmlNode *  settings)
overridevirtual

Load settings from the given XML node.

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

Reimplemented from ISubSettings.

◆ OnSettingAction()

void CMediaSettings::OnSettingAction ( const std::shared_ptr< const CSetting > &  setting)
overridevirtual

The given setting has been activated.

This callback is triggered whenever the given setting has been activated. This callback is only fired for CSettingAction settings.

Parameters
settingThe setting which has been activated.

Reimplemented from ISettingCallback.

◆ OnSettingChanged()

void CMediaSettings::OnSettingChanged ( const std::shared_ptr< const CSetting > &  setting)
overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters
settingThe setting whose value has been changed

Reimplemented from ISettingCallback.

◆ Save()

bool CMediaSettings::Save ( TiXmlNode *  settings) const
overridevirtual

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 from ISubSettings.

◆ SetWatchedMode()

void CMediaSettings::SetWatchedMode ( const std::string &  content,
WatchedMode  mode 
)

Set the watched mode for the given content type.

Parameters
contentCurrent content type
valueWatched mode to set
See also
GetWatchMode

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