osmscout::Settings Class Reference

#include <libosmscout-client-qt/include/osmscout/Settings.h>

Inheritance diagram for osmscout::Settings:

Collaboration diagram for osmscout::Settings:

Signals
void	MapDPIChange (double dpi)
void	OnlineTilesEnabledChanged (bool)
void	OnlineTileProviderIdChanged (const QString id)
void	OnlineTileProviderChanged (const OnlineTileProvider &provider)
void	OfflineMapChanged (bool)
void	RenderSeaChanged (bool)
void	StyleSheetDirectoryChanged (const QString dir)
void	StyleSheetFileChanged (const QString file)
void	VoiceLookupDirectoryChanged (const QString dir)
void	VoiceDirChanged (const QString voice)
void	FontNameChanged (const QString fontName)
void	FontSizeChanged (double fontSize)
void	ShowAltLanguageChanged (bool showAltLanguage)
void	UnitsChanged (const QString units)

Public Member Functions
	Settings (QSettings *providedStorage=nullptr)
	~Settings () override
double	GetPhysicalDPI () const
void	SetMapDPI (double dpi)
double	GetMapDPI () const
osmscout::Vehicle	GetRoutingVehicle () const
void	SetRoutingVehicle (const osmscout::Vehicle &vehicle)
bool	GetOnlineTilesEnabled () const
void	SetOnlineTilesEnabled (bool b)
const QList< OnlineTileProvider >	GetOnlineProviders () const
const OnlineTileProvider	GetOnlineTileProvider () const
const QList< MapProvider >	GetMapProviders () const
const QList< VoiceProvider >	GetVoiceProviders () const
const QString	GetOnlineTileProviderId () const
void	SetOnlineTileProviderId (QString id)
bool	loadOnlineTileProviders (QString path)
bool	loadMapProviders (QString path)
bool	loadVoiceProviders (QString path)
bool	GetOfflineMap () const
void	SetOfflineMap (bool)
bool	GetRenderSea () const
void	SetRenderSea (bool)
const QString	GetStyleSheetDirectory () const
void	SetStyleSheetDirectory (const QString dir)
const QString	GetVoiceLookupDirectory () const
void	SetVoiceLookupDirectory (const QString &voiceLookupDirectory)
const QString	GetVoiceDir () const
void	SetVoiceDir (const QString &voice)
const QString	GetStyleSheetFile () const
const QString	GetStyleSheetAbsoluteFile () const
void	SetStyleSheetFile (const QString file)
const std::unordered_map< std::string, bool >	GetStyleSheetFlags (const QString styleSheetFile)
const std::unordered_map< std::string, bool >	GetStyleSheetFlags ()
void	SetStyleSheetFlags (const QString styleSheetFile, std::unordered_map< std::string, bool > flags)
void	SetStyleSheetFlags (std::unordered_map< std::string, bool > flags)
QString	GetFontName () const
void	SetFontName (const QString fontName)
double	GetFontSize () const
void	SetFontSize (double fontSize)
bool	GetShowAltLanguage () const
void	SetShowAltLanguage (bool showAltLanguage)
const QString	GetHttpCacheDir () const
const QByteArray	GetCookieData () const
void	SetCookieData (QByteArray data)
QString	GetUnits () const
void	SetUnits (const QString units)

Properties
double	mapDPI
bool	onlineTiles
QString	onlineTileProviderId
bool	offlineMap
bool	renderSea
QString	styleSheetDirectory
QString	styleSheetFile
QString	fontName
double	fontSize
bool	showAltLanguage
QString	units
	metrics or imperial More...
QString	voiceLookupDirectory
QString	voiceDir

Detailed Description

Settings provides central point mutable configuration of OSMScout library. It uses Qt's QSettings for persistency. It may be accessed from DBThread instance.

List of online tile providers should be initialized at applicaiton start.

Settings::GetInstance()->loadOnlineTileProviders(
  ":/resources/online-tile-providers.json");

Before program exit, resources should be released by calling Settings::FreeInstance.

Constructor & Destructor Documentation

Settings()

osmscout::Settings::Settings

(

QSettings *

providedStorage = nullptr

)

~Settings()

osmscout::Settings::~Settings ( )

override

Member Function Documentation

FontNameChanged

void osmscout::Settings::FontNameChanged ( const QString  fontName )

signal

FontSizeChanged

void osmscout::Settings::FontSizeChanged ( double  fontSize )

signal

GetCookieData()

const QByteArray osmscout::Settings::GetCookieData

(

)

const

GetFontName()

QString osmscout::Settings::GetFontName

(

)

const

GetFontSize()

double osmscout::Settings::GetFontSize

(

)

const

GetHttpCacheDir()

const QString osmscout::Settings::GetHttpCacheDir

(

)

const

GetMapDPI()

double osmscout::Settings::GetMapDPI

(

)

const

GetMapProviders()

const QList<MapProvider> osmscout::Settings::GetMapProviders

(

)

const

GetOfflineMap()

bool osmscout::Settings::GetOfflineMap

(

)

const

GetOnlineProviders()

const QList<OnlineTileProvider> osmscout::Settings::GetOnlineProviders

(

)

const

GetOnlineTileProvider()

const OnlineTileProvider osmscout::Settings::GetOnlineTileProvider

(

)

const

GetOnlineTileProviderId()

const QString osmscout::Settings::GetOnlineTileProviderId

(

)

const

GetOnlineTilesEnabled()

bool osmscout::Settings::GetOnlineTilesEnabled

(

)

const

GetPhysicalDPI()

double osmscout::Settings::GetPhysicalDPI

(

)

const

GetRenderSea()

bool osmscout::Settings::GetRenderSea

(

)

const

GetRoutingVehicle()

osmscout::Vehicle osmscout::Settings::GetRoutingVehicle

(

)

const

GetShowAltLanguage()

bool osmscout::Settings::GetShowAltLanguage

(

)

const

GetStyleSheetAbsoluteFile()

const QString osmscout::Settings::GetStyleSheetAbsoluteFile

(

)

const

GetStyleSheetDirectory()

const QString osmscout::Settings::GetStyleSheetDirectory

(

)

const

GetStyleSheetFile()

const QString osmscout::Settings::GetStyleSheetFile

(

)

const

GetStyleSheetFlags() [1/2]

const std::unordered_map<std::string,bool> osmscout::Settings::GetStyleSheetFlags

(

const QString

styleSheetFile

)

GetStyleSheetFlags() [2/2]

const std::unordered_map<std::string,bool> osmscout::Settings::GetStyleSheetFlags

(

)

GetUnits()

QString osmscout::Settings::GetUnits

(

)

const

GetVoiceDir()

const QString osmscout::Settings::GetVoiceDir

(

)

const

GetVoiceLookupDirectory()

const QString osmscout::Settings::GetVoiceLookupDirectory

(

)

const

GetVoiceProviders()

const QList<VoiceProvider> osmscout::Settings::GetVoiceProviders

(

)

const

loadMapProviders()

bool osmscout::Settings::loadMapProviders

(

QString

path

)

loadOnlineTileProviders()

bool osmscout::Settings::loadOnlineTileProviders

(

QString

path

)

loadVoiceProviders()

bool osmscout::Settings::loadVoiceProviders

(

QString

path

)

MapDPIChange

void osmscout::Settings::MapDPIChange ( double  dpi )

signal

OfflineMapChanged

void osmscout::Settings::OfflineMapChanged ( bool  )

signal

OnlineTileProviderChanged

void osmscout::Settings::OnlineTileProviderChanged ( const OnlineTileProvider &  provider )

signal

OnlineTileProviderIdChanged

void osmscout::Settings::OnlineTileProviderIdChanged ( const QString  id )

signal

OnlineTilesEnabledChanged

void osmscout::Settings::OnlineTilesEnabledChanged ( bool  )

signal

RenderSeaChanged

void osmscout::Settings::RenderSeaChanged ( bool  )

signal

SetCookieData()

void osmscout::Settings::SetCookieData

(

QByteArray

data

)

SetFontName()

void osmscout::Settings::SetFontName

(

const QString

fontName

)

SetFontSize()

void osmscout::Settings::SetFontSize

(

double

fontSize

)

SetMapDPI()

void osmscout::Settings::SetMapDPI

(

double

dpi

)

SetOfflineMap()

void osmscout::Settings::SetOfflineMap

(

bool

)

SetOnlineTileProviderId()

void osmscout::Settings::SetOnlineTileProviderId

(

QString

id

)

SetOnlineTilesEnabled()

void osmscout::Settings::SetOnlineTilesEnabled

(

bool

b

)

SetRenderSea()

void osmscout::Settings::SetRenderSea

(

bool

)

SetRoutingVehicle()

void osmscout::Settings::SetRoutingVehicle

(

const osmscout::Vehicle &

vehicle

)

SetShowAltLanguage()

void osmscout::Settings::SetShowAltLanguage

(

bool

showAltLanguage

)

SetStyleSheetDirectory()

void osmscout::Settings::SetStyleSheetDirectory

(

const QString

dir

)

SetStyleSheetFile()

void osmscout::Settings::SetStyleSheetFile

(

const QString

file

)

SetStyleSheetFlags() [1/2]

void osmscout::Settings::SetStyleSheetFlags	(	const QString	styleSheetFile,
		std::unordered_map< std::string, bool >	flags
	)

SetStyleSheetFlags() [2/2]

void osmscout::Settings::SetStyleSheetFlags

(

std::unordered_map< std::string, bool >

flags

)

SetUnits()

void osmscout::Settings::SetUnits

(

const QString

units

)

SetVoiceDir()

void osmscout::Settings::SetVoiceDir

(

const QString &

voice

)

SetVoiceLookupDirectory()

void osmscout::Settings::SetVoiceLookupDirectory

(

const QString &

voiceLookupDirectory

)

ShowAltLanguageChanged

void osmscout::Settings::ShowAltLanguageChanged ( bool  showAltLanguage )

signal

StyleSheetDirectoryChanged

void osmscout::Settings::StyleSheetDirectoryChanged ( const QString  dir )

signal

StyleSheetFileChanged

void osmscout::Settings::StyleSheetFileChanged ( const QString  file )

signal

UnitsChanged

void osmscout::Settings::UnitsChanged ( const QString  units )

signal

VoiceDirChanged

void osmscout::Settings::VoiceDirChanged ( const QString  voice )

signal

VoiceLookupDirectoryChanged

void osmscout::Settings::VoiceLookupDirectoryChanged ( const QString  dir )

signal

Property Documentation

fontName

QString osmscout::Settings::fontName

readwrite

fontSize

double osmscout::Settings::fontSize

readwrite

mapDPI

double osmscout::Settings::mapDPI

readwrite

offlineMap

bool osmscout::Settings::offlineMap

readwrite

onlineTileProviderId

QString osmscout::Settings::onlineTileProviderId

readwrite

onlineTiles

bool osmscout::Settings::onlineTiles

readwrite

renderSea

bool osmscout::Settings::renderSea

readwrite

showAltLanguage

bool osmscout::Settings::showAltLanguage

readwrite

styleSheetDirectory

QString osmscout::Settings::styleSheetDirectory

readwrite

styleSheetFile

QString osmscout::Settings::styleSheetFile

readwrite

units

QString osmscout::Settings::units

readwrite

metrics or imperial

voiceDir

QString osmscout::Settings::voiceDir

readwrite

voiceLookupDirectory

QString osmscout::Settings::voiceLookupDirectory

readwrite

---

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

• libosmscout-client-qt/include/osmscout/Settings.h