ApplicationSettings Class Reference

#include <ApplicationSettings.h>

Inherits QObject.

Signals
void	audioEffectsEnabledChanged ()
void	audioVoicesEnabledChanged ()
void	automaticDownloadsEnabledChanged ()
void	barHiddenChanged ()
void	baseFontSizeChanged ()
void	demoModeChanged ()
void	downloadServerUrlChanged ()
void	embeddedFontChanged ()
void	exeCountChanged ()
void	filterLevelMaxChanged ()
void	filterLevelMinChanged ()
void	fontCapitalizationChanged ()
void	fontChanged ()
void	fullscreenChanged ()
void	kioskModeChanged ()
void	localeChanged ()
void	sectionVisibleChanged ()
void	showLockedActivitiesChanged ()
void	virtualKeyboardChanged ()

Public Member Functions
Q_INVOKABLE QVariantMap	loadActivityConfiguration (const QString &activity)
Q_INVOKABLE void	saveActivityConfiguration (const QString &activity, const QVariantMap &data)

Properties
int	baseFontSize
int	baseFontSizeMax
int	baseFontSizeMin
QString	downloadServerUrl
quint32	exeCount
quint32	filterLevelMax
quint32	filterLevelMin
QString	font
quint32	fontCapitalization
bool	isAudioEffectsEnabled
bool	isAudioVoicesEnabled
bool	isAutomaticDownloadsEnabled
bool	isBarHidden
bool	isDemoMode
bool	isEmbeddedFont
bool	isFullscreen
bool	isKioskMode
bool	isVirtualKeyboard
QString	locale
bool	sectionVisible
bool	showLockedActivities

Detailed Description

Singleton that contains GCompris' persistent settings.

Settings are persisted using QSettings, which stores them in platform specific locations.

The settings are subdivided in different groups of settings.

[General] settings are mostly changeable by users in the DialogConfig dialog.

[Admin] and [Internal] settings are not changeable by the user and used for internal purposes. Should only be changed if you really know what you are doing.

The [Favorite] group is auto-generated from the favorite activities selected by a user.

Besides these global settings there is one group for each activity that stores persistent settings.

Settings defaults are defined in the source code.

See also

DialogActivityConfig

Definition at line 63 of file ApplicationSettings.h.

Member Function Documentation

QVariantMap ApplicationSettings::loadActivityConfiguration

(

const QString &

activity

)

Loads per-activity configuration data for activity.

Parameters

activity

Name of the activity that wants to persist settings.

Returns

Map of configuration items.

Definition at line 320 of file ApplicationSettings.cpp.

void ApplicationSettings::saveActivityConfiguration	(	const QString &	activity,
		const QVariantMap &	data
	)

Stores per-activity configuration data for activity.

Parameters

activity	Name of the activity that wants to persist settings.
data	Map of configuration data so save.

Definition at line 310 of file ApplicationSettings.cpp.

Property Documentation

int ApplicationSettings::baseFontSize

readwrite

Current base font-size used for font scaling.

This setting is the basis for application-wide font-scaling. A value of 0 means to use the font-size as set by the application. Other values between baseFontSizeMin and baseFontSizeMax enforce font-scaling.

See also

GCText.fontSize baseFontSizeMin baseFontSizeMax

Definition at line 166 of file ApplicationSettings.h.

int ApplicationSettings::baseFontSizeMax

read

Maximum allowed value for font-scaling.

Constant value: +7

Definition at line 180 of file ApplicationSettings.h.

int ApplicationSettings::baseFontSizeMin

read

Minimum allowed value for font-scaling.

Constant value: -7

Definition at line 173 of file ApplicationSettings.h.

QString ApplicationSettings::downloadServerUrl

readwrite

Base-URL for resource downloads.

See also

DownloadManager

Definition at line 189 of file ApplicationSettings.h.

quint32 ApplicationSettings::filterLevelMax

readwrite

Maximum value for difficulty level filter.

Definition at line 139 of file ApplicationSettings.h.

quint32 ApplicationSettings::filterLevelMin

readwrite

Minimum value for difficulty level filter.

Definition at line 134 of file ApplicationSettings.h.

QString ApplicationSettings::font

readwrite

Currently selected font.

Definition at line 104 of file ApplicationSettings.h.

quint32 ApplicationSettings::fontCapitalization

readwrite

Font Capitalization.

Force all texts to be rendered in UpperCase, LowerCase or MixedCase (default)

See also

font

Definition at line 120 of file ApplicationSettings.h.

bool ApplicationSettings::isAudioEffectsEnabled

readwrite

Whether audio effects should be enabled.

Definition at line 83 of file ApplicationSettings.h.

bool ApplicationSettings::isAudioVoicesEnabled

readwrite

Whether audio voices/speech should be enabled.

Definition at line 78 of file ApplicationSettings.h.

bool ApplicationSettings::isAutomaticDownloadsEnabled

readwrite

Whether downloads/updates of resource files should be done automatically, without user-interaction.

Note, that on Android GCompris currently can't distinguish Wifi from mobile data connections (cf. Qt ticket #30394).

Definition at line 129 of file ApplicationSettings.h.

bool ApplicationSettings::isDemoMode

readwrite

Whether in demo mode.

Definition at line 144 of file ApplicationSettings.h.

bool ApplicationSettings::isEmbeddedFont

readwrite

Whether currently active font is a shipped font (or a system font).

Updated automatically.

See also

font

Definition at line 112 of file ApplicationSettings.h.

bool ApplicationSettings::isFullscreen

readwrite

Whether GCompris should run in fullscreen mode.

Definition at line 88 of file ApplicationSettings.h.

bool ApplicationSettings::isKioskMode

readwrite

Whether kiosk mode is currently active.

Definition at line 149 of file ApplicationSettings.h.

bool ApplicationSettings::isVirtualKeyboard

readwrite

Whether on-screen keyboard should be enabled per default in activities that use it.

Definition at line 94 of file ApplicationSettings.h.

QString ApplicationSettings::locale

readwrite

Locale string for currently active language.

Definition at line 99 of file ApplicationSettings.h.

bool ApplicationSettings::sectionVisible

readwrite

Whether the section selection row is visible in the menu view.

Definition at line 154 of file ApplicationSettings.h.

bool ApplicationSettings::showLockedActivities

readwrite

Whether to show locked activities.

False if in Demo mode, true otherwise.

Definition at line 73 of file ApplicationSettings.h.

---

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

• ApplicationSettings.h
• ApplicationSettings.cpp