CMediaSourceSettings Class Reference

#include <MediaSourceSettings.h>

Inheritance diagram for CMediaSourceSettings:

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 (KODI::MEDIA::MediaSection section)
const std::string &	GetDefaultSource (KODI::MEDIA::MediaSection section) const
void	SetDefaultSource (KODI::MEDIA::MediaSection section, std::string_view source)
bool	UpdateSource (KODI::MEDIA::MediaSection section, std::string_view strOldName, std::string_view strUpdateChild, const std::string &strUpdateValue)
bool	DeleteSource (KODI::MEDIA::MediaSection section, std::string_view strName, std::string_view strPath, bool virtualSource=false)
bool	AddShare (KODI::MEDIA::MediaSection section, const CMediaSource &share)
bool	UpdateShare (KODI::MEDIA::MediaSection section, 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 CMediaSourceSettings &	GetInstance ()
static std::string	GetSourcesFile ()
static bool	HasDefaultSource (KODI::MEDIA::MediaSection section)

Protected Member Functions
	CMediaSourceSettings ()
	CMediaSourceSettings (const CMediaSourceSettings &)=delete
CMediaSourceSettings &	operator= (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	(	KODI::MEDIA::MediaSection	section,
		const CMediaSource &	share )

Clear()

void CMediaSourceSettings::Clear

(

)

DeleteSource()

bool CMediaSourceSettings::DeleteSource	(	KODI::MEDIA::MediaSection	section,
		std::string_view	strName,
		std::string_view	strPath,
		bool	virtualSource = false )

GetDefaultSource()

const std::string & CMediaSourceSettings::GetDefaultSource

(

KODI::MEDIA::MediaSection

section

)

const

GetInstance()

CMediaSourceSettings & CMediaSourceSettings::GetInstance ( )

static

GetSources()

std::vector< CMediaSource > & CMediaSourceSettings::GetSources

(

KODI::MEDIA::MediaSection

section

)

GetSourcesFile()

std::string CMediaSourceSettings::GetSourcesFile ( )

static

HasDefaultSource()

bool CMediaSourceSettings::HasDefaultSource ( KODI::MEDIA::MediaSection section )

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	(	KODI::MEDIA::MediaSection	section,
		std::string_view	source )

UpdateShare()

bool CMediaSourceSettings::UpdateShare	(	KODI::MEDIA::MediaSection	section,
		std::string_view	oldName,
		const CMediaSource &	share )

UpdateSource()

bool CMediaSourceSettings::UpdateSource	(	KODI::MEDIA::MediaSection	section,
		std::string_view	strOldName,
		std::string_view	strUpdateChild,
		const std::string &	strUpdateValue )

---

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

• MediaSourceSettings.h
• MediaSourceSettings.cpp