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

#include <MediaSourceSettings.h>

Inheritance diagram for CMediaSourceSettings:
ISettingsHandler

Public Member Functions

void OnSettingsLoaded () override
 Settings have been loaded.
 
void OnSettingsUnloaded () override
 Setting values have been unloaded.
 
bool Load ()
 
bool Load (const std::string &file)
 
bool Save () const
 
bool Save (const std::string &file) const
 
void Clear ()
 
std::vector< CMediaSource > * GetSources (std::string_view type)
 
const std::string & GetDefaultSource (std::string_view type) const
 
void SetDefaultSource (std::string_view type, std::string_view source)
 
bool UpdateSource (std::string_view strType, std::string_view strOldName, std::string_view strUpdateChild, const std::string &strUpdateValue)
 
bool DeleteSource (std::string_view strType, std::string_view strName, std::string_view strPath, bool virtualSource=false)
 
bool AddShare (std::string_view type, const CMediaSource &share)
 
bool UpdateShare (std::string_view type, std::string_view oldName, const CMediaSource &share)
 
- Public Member Functions inherited from ISettingsHandler
virtual ~ISettingsHandler ()=default
 
virtual bool OnSettingsLoading ()
 Settings loading has been initiated.
 
virtual bool OnSettingsSaving () const
 Settings saving has been initiated.
 
virtual void OnSettingsSaved () const
 Settings have been saved.
 
virtual void OnSettingsCleared ()
 Settings have been cleared.
 

Static Public Member Functions

static CMediaSourceSettingsGetInstance ()
 
static std::string GetSourcesFile ()
 

Protected Member Functions

 CMediaSourceSettings ()
 
 CMediaSourceSettings (const CMediaSourceSettings &)=delete
 
CMediaSourceSettingsoperator= (CMediaSourceSettings const &)=delete
 
 ~CMediaSourceSettings () override
 

Constructor & Destructor Documentation

◆ CMediaSourceSettings() [1/2]

CMediaSourceSettings::CMediaSourceSettings ( )
protected

◆ CMediaSourceSettings() [2/2]

CMediaSourceSettings::CMediaSourceSettings ( const CMediaSourceSettings )
protecteddelete

◆ ~CMediaSourceSettings()

CMediaSourceSettings::~CMediaSourceSettings ( )
overrideprotecteddefault

Member Function Documentation

◆ AddShare()

bool CMediaSourceSettings::AddShare ( std::string_view  type,
const CMediaSource share 
)

◆ Clear()

void CMediaSourceSettings::Clear ( )

◆ DeleteSource()

bool CMediaSourceSettings::DeleteSource ( std::string_view  strType,
std::string_view  strName,
std::string_view  strPath,
bool  virtualSource = false 
)

◆ GetDefaultSource()

const std::string & CMediaSourceSettings::GetDefaultSource ( std::string_view  type) const

◆ GetInstance()

CMediaSourceSettings & CMediaSourceSettings::GetInstance ( )
static

◆ GetSources()

std::vector< CMediaSource > * CMediaSourceSettings::GetSources ( std::string_view  type)

◆ GetSourcesFile()

std::string CMediaSourceSettings::GetSourcesFile ( )
static

◆ Load() [1/2]

bool CMediaSourceSettings::Load ( )

◆ Load() [2/2]

bool CMediaSourceSettings::Load ( const std::string &  file)

◆ OnSettingsLoaded()

void CMediaSourceSettings::OnSettingsLoaded ( )
overridevirtual

Settings have been loaded.

This callback can be used to trigger loading other settings.

Reimplemented from ISettingsHandler.

◆ OnSettingsUnloaded()

void CMediaSourceSettings::OnSettingsUnloaded ( )
overridevirtual

Setting values have been unloaded.

This callback can be used to trigger uninitializing any state variables (e.g. before re-loading the settings).

Reimplemented from ISettingsHandler.

◆ operator=()

CMediaSourceSettings & CMediaSourceSettings::operator= ( CMediaSourceSettings const &  )
protecteddelete

◆ Save() [1/2]

bool CMediaSourceSettings::Save ( ) const

◆ Save() [2/2]

bool CMediaSourceSettings::Save ( const std::string &  file) const

◆ SetDefaultSource()

void CMediaSourceSettings::SetDefaultSource ( std::string_view  type,
std::string_view  source 
)

◆ UpdateShare()

bool CMediaSourceSettings::UpdateShare ( std::string_view  type,
std::string_view  oldName,
const CMediaSource share 
)

◆ UpdateSource()

bool CMediaSourceSettings::UpdateSource ( std::string_view  strType,
std::string_view  strOldName,
std::string_view  strUpdateChild,
const std::string &  strUpdateValue 
)

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