Settings Class Reference

Class responsible for application settings description and management. More...

#include <settings.hpp>

Public Member Functions
	Settings ()
	Default class constructor for Settings module. More...
	~Settings ()
	Destructor designed for class Settings. More...
void	Settings_SetDebugInformations (bool debugInformations)
	Setter function designed for debugging informations preference changes. More...
void	Settings_SetUnrestrictedLimbMovement (bool unrestrictedLimbMovement)
	Setter function designed for unrestricted limb movement preference setting. More...
void	Settings_SetLanguage (Language language)
	Setter function meant for language preference changing. More...
bool	Settings_GetDebugInformations ()
	Getter member function that returns mEnableDebugInformations member variable. More...
bool	Settings_GetUnrestrictedLimbMovement ()
	Getter function that returns previously set option of unrestricted limb movement. More...
QString	Settings_GetLanguage (bool getByID)
	Getter function with parameter meant for selected language choice reading. More...

Private Attributes
bool	mEnableDebugInformations
	bool that keeps the information whether debugging informations are meant to be reported.
bool	mEnableUnrestrictedLimbMovement
	bool value that describes the choice of unrestricted dual limb movement.
Language	mLanguage
	Language member variable that keeps the currently selected language.

Detailed Description

Class responsible for application settings description and management.

Application settings are handled through user interface section (see MainWindow), as well as permanently stored via XmlParser module. This class encapsulates possible application options, which users may change to fit their requirements.

See also

MainWindow, XmlParser

Constructor & Destructor Documentation

Settings()

Settings::Settings

(

)

Default class constructor for Settings module.

A default constructor function responsible for actions bound with instance creation.

See also

~Settings()

~Settings()

Settings::~Settings

(

)

Destructor designed for class Settings.

Base destructor function with no custom-defined properties.

See also

Settings()

Member Function Documentation

Settings_GetDebugInformations()

bool Settings::Settings_GetDebugInformations

(

)

Getter member function that returns mEnableDebugInformations member variable.

Function is designed for reading of member describing the choice of additional debugging informations.

Returns

bool - TRUE in case of enabled debugging informations, FALSE otherwise

Settings_GetLanguage()

QString Settings::Settings_GetLanguage

(

bool

getByID

)

Getter function with parameter meant for selected language choice reading.

Function accepts a parameter and returns a text string with the description of selected language. If TRUE is passed to this function, a string containing an index of selected language is returned. In case of FALSE at function input, this function returns a text string with selected and translated language description.

Parameters

getByID

- a choice of output format

Returns

QString - a language index text string or its description

Settings_GetUnrestrictedLimbMovement()

bool Settings::Settings_GetUnrestrictedLimbMovement

(

)

Getter function that returns previously set option of unrestricted limb movement.

Function returns mEnableUnrestrictedLimbMovement for its further processing.

Returns

bool - TRUE if unrestricted movement is enabled, FALSE otherwise

Settings_SetDebugInformations()

void Settings::Settings_SetDebugInformations

(

bool

debugInformations

)

Setter function designed for debugging informations preference changes.

This setter function accepts a parameter that is set to mEnableDebugInformations member variable.

Parameters

debugInformations

- a boolean value that in its TRUE state enables additional debugging informations, FALSE stands for its deactivation

Settings_SetLanguage()

void Settings::Settings_SetLanguage

(

Language

language

)

Setter function meant for language preference changing.

This function changes the language of Limb Range Analyzer to value set by parameter.

Parameters

language

- enumeration item that represents the preferred language

See also

Language

Settings_SetUnrestrictedLimbMovement()

void Settings::Settings_SetUnrestrictedLimbMovement

(

bool

unrestrictedLimbMovement

)

Setter function designed for unrestricted limb movement preference setting.

Setter function that modifies mEnableUnrestrictedLimbMovement member through received parameter.

Parameters

unrestrictedLimbMovement

- a boolean value that in its TRUE state enables unrestricted limb movement while 3D visualization is running, FALSE sets it otherwise

---

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

• D:/Qt WS/LimbRangeAnalyzer/Headers/settings.hpp
• D:/Qt WS/LimbRangeAnalyzer/Sources/settings.cpp