#include <libmythbase/configuration.h>

Public Member Functions
	XmlConfiguration ()

	XmlConfiguration (QString fileName)

bool	Load ()

bool	Save ()

bool	FileExists ()

bool	GetValue (const QString &setting, const bool defaultValue)

int	GetValue (const QString &setting, const int defaultValue)

QString	GetValue (const QString &setting, const QString &defaultValue)

QString	GetValue (const QString &setting, const char *defaultValue)
	get the string value stored as setting with a default C string. More...

void	SetValue (const QString &setting, bool value)

void	SetValue (const QString &setting, int value)

void	SetValue (const QString &setting, const char *value)
	set value to a C string; just in case, for overload resolution More...

void	SetValue (const QString &setting, const QString &value)

void	ClearValue (const QString &setting)

template<typename T >
std::enable_if_t< std::chrono::__is_duration< T >::value, T >	GetDuration (const QString &setting, T defaultValue=T::zero())

template<typename T >
std::enable_if_t< std::chrono::__is_duration< T >::value >	SetDuration (const QString &setting, T value)

Static Public Attributes
static constexpr auto	kDefaultFilename = "config.xml"

static const QString	kDefaultDB {"Database/"}

static const QString	kDefaultWOL {"WakeOnLAN/"}

static const QString	kDefaultMFE {"UPnP/MythFrontend/DefaultBackend/"}

static const QString	kDefaultPIN {kDefaultMFE + "SecurityPin"}

static const QString	kDefaultUSN {kDefaultMFE + "USN"}

Protected Member Functions
QDomNode	FindNode (const QString &setting, bool create)

QDomNode	FindNode (QStringList &path, QDomNode &current, bool create)

QString	GetValue (const QString &setting)

Protected Attributes
QString	m_path {GetConfDir()}

QString	m_fileName {kDefaultFilename}

QDomDocument	m_config

QDomNode	m_rootNode

Detailed Description

Definition at line 40 of file configuration.h.

Constructor & Destructor Documentation

◆ XmlConfiguration() [1/2]

XmlConfiguration::XmlConfiguration ( )

inline

Definition at line 65 of file configuration.h.

◆ XmlConfiguration() [2/2]

XmlConfiguration::XmlConfiguration ( QString fileName )

inlineexplicit

Definition at line 66 of file configuration.h.

Member Function Documentation

◆ ClearValue()

void XmlConfiguration::ClearValue ( const QString & setting )

Definition at line 246 of file configuration.cpp.

◆ FileExists()

bool XmlConfiguration::FileExists ( )

Definition at line 28 of file configuration.cpp.

Referenced by main().

◆ FindNode() [1/2]

QDomNode XmlConfiguration::FindNode	(	const QString &	setting,
		bool	create
	)

protected

Definition at line 169 of file configuration.cpp.

Referenced by ClearValue(), FindNode(), GetValue(), and SetValue().

◆ FindNode() [2/2]

QDomNode XmlConfiguration::FindNode	(	QStringList &	path,
		QDomNode &	current,
		bool	create
	)

protected

Definition at line 175 of file configuration.cpp.

◆ GetDuration()

template<typename T >

std::enable_if_t< std::chrono::__is_duration< T >::value, T > XmlConfiguration::GetDuration	(	const QString &	setting,
		T	defaultValue = `T::zero()`
	)

inline

Definition at line 126 of file configuration.h.

Referenced by UPnpNotifyTask::UPnpNotifyTask(), and UPnpSearchTask::UPnpSearchTask().

◆ GetValue() [1/5]

QString XmlConfiguration::GetValue ( const QString & setting )

protected

Definition at line 202 of file configuration.cpp.

Referenced by UPnpDeviceDesc::GetHostName(), MythHTTPServer::Init(), HTTPRequest::IsUrlProtected(), MediaRenderer::MediaRenderer(), MMulticastSocketDevice::MMulticastSocketDevice(), MythFEXML::MythFEXML(), UPnpDeviceDesc::OutputDevice(), anonymous_namespace{mythcontext.cpp}::GUISettingsCache::save(), SSDPExtension::SSDPExtension(), UPnpCDS::UPnpCDS(), UPnpCMGR::UPnpCMGR(), and UPnpMSRR::UPnpMSRR().

◆ GetValue() [2/5]

bool XmlConfiguration::GetValue	(	const QString &	setting,
		const bool	defaultValue
	)

inline

Definition at line 77 of file configuration.h.

◆ GetValue() [3/5]

QString XmlConfiguration::GetValue	(	const QString &	setting,
		const char *	defaultValue
	)

inline

get the string value stored as setting with a default C string.

This fixes overload resolution, making it choose this instead of the bool one.

Definition at line 95 of file configuration.h.

◆ GetValue() [4/5]

int XmlConfiguration::GetValue	(	const QString &	setting,
		const int	defaultValue
	)

inline

Definition at line 82 of file configuration.h.

◆ GetValue() [5/5]

QString XmlConfiguration::GetValue	(	const QString &	setting,
		const QString &	defaultValue
	)

inline

Definition at line 87 of file configuration.h.

◆ Load()

bool XmlConfiguration::Load ( void )

Definition at line 35 of file configuration.cpp.

◆ Save()

bool XmlConfiguration::Save ( )

Definition at line 96 of file configuration.cpp.

Referenced by anonymous_namespace{mythcontext.cpp}::GUISettingsCache::save().

◆ SetDuration()

template<typename T >

std::enable_if_t< std::chrono::__is_duration< T >::value > XmlConfiguration::SetDuration	(	const QString &	setting,
		T	value
	)

inline

Definition at line 137 of file configuration.h.

◆ SetValue() [1/4]

void XmlConfiguration::SetValue	(	const QString &	setting,
		bool	value
	)

inline

Definition at line 101 of file configuration.h.

Referenced by anonymous_namespace{mythcontext.cpp}::GUISettingsCache::save().

◆ SetValue() [2/4]

void XmlConfiguration::SetValue	(	const QString &	setting,
		const char *	value
	)

inline

set value to a C string; just in case, for overload resolution

Note: : This should probably never be used since the C string should have already been converted to a QString.

Definition at line 113 of file configuration.h.

◆ SetValue() [3/4]

void XmlConfiguration::SetValue	(	const QString &	setting,
		const QString &	value
	)

Definition at line 222 of file configuration.cpp.

◆ SetValue() [4/4]

void XmlConfiguration::SetValue	(	const QString &	setting,
		int	value
	)

inline

Definition at line 105 of file configuration.h.

Member Data Documentation

◆ kDefaultDB

const QString XmlConfiguration::kDefaultDB {"Database/"}

inlinestatic

Definition at line 59 of file configuration.h.

Referenced by MythContext::Impl::LoadDatabaseSettings(), and MythDB::SaveDatabaseParams().

◆ kDefaultFilename

constexpr auto XmlConfiguration::kDefaultFilename = "config.xml"

staticconstexpr

Definition at line 57 of file configuration.h.

Referenced by MythContext::Impl::ChooseBackend(), MythContext::Impl::DefaultUPnP(), and MythContext::Impl::LoadDatabaseSettings().

◆ kDefaultMFE

const QString XmlConfiguration::kDefaultMFE {"UPnP/MythFrontend/DefaultBackend/"}

inlinestatic

Definition at line 61 of file configuration.h.

◆ kDefaultPIN

const QString XmlConfiguration::kDefaultPIN {kDefaultMFE + "SecurityPin"}

inlinestatic

Definition at line 62 of file configuration.h.

Referenced by BackendSelection::Accept(), and MythContext::Impl::DefaultUPnP().

◆ kDefaultUSN

const QString XmlConfiguration::kDefaultUSN {kDefaultMFE + "USN"}

inlinestatic

Definition at line 63 of file configuration.h.

Referenced by BackendSelection::Accept(), and MythContext::Impl::DefaultUPnP().

◆ kDefaultWOL

const QString XmlConfiguration::kDefaultWOL {"WakeOnLAN/"}

inlinestatic

Definition at line 60 of file configuration.h.

Referenced by MythContext::Impl::LoadDatabaseSettings(), and MythDB::SaveDatabaseParams().

◆ m_config

QDomDocument XmlConfiguration::m_config

protected

Definition at line 47 of file configuration.h.

Referenced by FindNode(), Load(), Save(), and SetValue().

◆ m_fileName

QString XmlConfiguration::m_fileName {kDefaultFilename}

protected

Definition at line 45 of file configuration.h.

Referenced by FileExists(), Load(), and Save().

◆ m_path

QString XmlConfiguration::m_path {GetConfDir()}

protected

Definition at line 44 of file configuration.h.

Referenced by FileExists(), Load(), and Save().

◆ m_rootNode

QDomNode XmlConfiguration::m_rootNode

protected

Definition at line 48 of file configuration.h.

Referenced by FindNode(), and Load().

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

mythtv/libs/libmythbase/configuration.h
mythtv/libs/libmythbase/configuration.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XmlConfiguration() [1/2]

◆ XmlConfiguration() [2/2]

Member Function Documentation

◆ ClearValue()

◆ FileExists()

◆ FindNode() [1/2]

◆ FindNode() [2/2]

◆ GetDuration()

◆ GetValue() [1/5]

◆ GetValue() [2/5]

◆ GetValue() [3/5]

◆ GetValue() [4/5]

◆ GetValue() [5/5]

◆ Load()

◆ Save()

◆ SetDuration()

◆ SetValue() [1/4]

◆ SetValue() [2/4]

◆ SetValue() [3/4]

◆ SetValue() [4/4]

Member Data Documentation

◆ kDefaultDB

◆ kDefaultFilename

◆ kDefaultMFE

◆ kDefaultPIN

◆ kDefaultUSN

◆ kDefaultWOL

◆ m_config

◆ m_fileName

◆ m_path

◆ m_rootNode