Systeme de gestion des preferences. More...

#include <OPreferenceManager.h>

Collaboration diagram for OPreferenceManager:

Public Member Functions
	OPreferenceManager ()

	OPreferenceManager (const QString &currentDirectory)

	OPreferenceManager (const QString &rootNodeName, const QString &paramNodeName)

	OPreferenceManager (const QString &rootNodeName, const QString &paramNodeName, const QString &currentDirectory)

virtual	~OPreferenceManager ()

void	completePreferences (QString filePath)
	Complete les prÃ©fÃ©rences utilisateur manquante avec les valeurs par dÃ©faut. More...

void	loadDefault (const char *defaultParams[][2], int nbParams)
	Charge le tableau associatif preference/valeur avec les valeurs par defaut. More...

void	reset ()
	Vide le tableau associatif preference/valeur. More...

void	setXMLRootNodeName (QString name)
	Change le nom du noeud root du fichier XML. More...

void	setXMLParamNodeName (QString name)
	Change le nom des noeuds de parametres dans le fichier XML. More...

bool	readXML (QString fileName)
	Ouvre un fichier de preference en XML et le parcours pour mettre a jour la tableau de preferences. More...

bool	writeXML (QString fileName)
	Enregistre le fichier de preference au format XML. More...

bool	exists (const QString &pref)
	Test si une preference est presente dans le tableau de preferences. Utilise la categorie courante. More...

bool	exists (const QString &dir, const QString &pref)
	Test si une preference est presente dans le tableau de preferences. Utilise la categorie specifiee. More...

QString	getDirectory (const QString &pref)
	Recherche le nom de la categorie pour une preference donnee. More...

void	setCurrentDirectory (QString dir)
	Defini la categorie courante pour la lecture et l'ecriture de parametres. More...

QString	getCurrentDirectory ()
	Retourne la categorie courante pour la lecture et l'ecriture de parametres. More...

void	setString (const QString &pref, const QString &value)
	Met a jour la valeur associee a une preference. More...

void	setString (const QString &dir, const QString &pref, const QString &value)
	Met a jour la valeur associee a une preference. More...

QString	getString (const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. More...

QString	getString (const QString &dir, const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee. More...

void	setStringArray (const QString &pref, const QString *valueArray, const int &sizeArray)
	Met a jour un tableau de valeurs associees a une preference. More...

void	setStringArray (const QString &dir, const QString &pref, const QString *valueArray, const int &sizeArray)
	Met a jour un tableau de valeurs associees a une preference. More...

QString *	getStringArray (const QString &pref, int &sizeArray)
	Recherche une ressource et retourne son tableau de valeurs associees. Utilise la categorie courante. More...

QString *	getStringArray (const QString &dir, const QString &pref, int &sizeArray)
	Recherche une ressource et retourne son tableau de valeurs associees. Utilise la categorie specifiee. More...

void	setUInt (const QString &pref, const unsigned int &value)

void	setUInt (const QString &dir, const QString &pref, const unsigned int &value)

void	setUInt (const QString &pref, const size_t &value)

void	setUInt (const QString &dir, const QString &pref, const size_t &value)

void	setUInt (const QString &pref, const unsigned long &value)

void	setUInt (const QString &dir, const QString &pref, const unsigned long &value)

void	setInt (const QString &pref, const int &value)
	Met a jour la valeur associee a une preference. More...

void	setInt (const QString &dir, const QString &pref, const int &value)
	Met a jour la valeur associee a une preference. More...

int	getInt (const QString &pref)
	Recherche une ressource et retourne sa valeur associee.Utilise la categorie courante. More...

int	getInt (const QString &dir, const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. Utilise la categorie specifiee. More...

void	setBool (const QString &pref, const bool &value)
	Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante. More...

void	setBool (const QString &dir, const QString &pref, const bool &value)
	Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee. More...

bool	getBool (const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. More...

bool	getBool (const QString &dir, const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee. More...

void	setFloat (const QString &pref, const float &value)
	Met a jour la valeur associee a une preference. More...

void	setFloat (const QString &dir, const QString &pref, const float &value)
	Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee. More...

float	getFloat (const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. More...

float	getFloat (const QString &dir, const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee. More...

void	setDouble (const QString &pref, const double &value)
	Met a jour la valeur associee a une preference. More...

void	setDouble (const QString &dir, const QString &pref, const double &value)
	Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee. More...

double	getDouble (const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. More...

double	getDouble (const QString &dir, const QString &pref)
	Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee. More...

void	setFrame (const QString &pref, const int &posX, const int &posY, const int &sizeX, const int &sizeY)
	Sauvegarde la position et la taille d'une fenetre. More...

void	setFrame (const QString &dir, const QString &pref, const int &posX, const int &posY, const int &sizeX, const int &sizeY)
	Sauvegarde la position et la taille d'une fenetre. More...

void	getFrame (const QString &pref, int &posX, int &posY, int &sizeX, int &sizeY)
	Charge la position et la taille d'une fenetre. Utilise la categorie courante. More...

void	getFrame (const QString &dir, const QString &pref, int &posX, int &posY, int &sizeX, int &sizeY)
	Charge la position et la taille d'une fenetre. Utilise la categorie specifiee. More...

void	setPoint (const QString &pref, const int &x, const int &y)
	Sauvegarde les coordonnees en pixel d'un point. More...

void	setPoint (const QString &dir, const QString &pref, const int &x, const int &y)
	Sauvegarde les coordonnees en pixel d'un point. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee. More...

void	getPoint (const QString &pref, int &x, int &y)
	Charge les coordonnees en pixel d'un point. Utilise la categorie courante. More...

void	getPoint (const QString &dir, const QString &pref, int &x, int &y)
	Charge les coordonnees en pixel d'un point. Utilise la categorie specifiee. More...

void	setColor (const QString &pref, const float &r, const float &g, const float &b)
	Sauvegarde les composantes RGB d'une couleur, en float.Utilise la categorie courante. More...

void	setColor (const QString &dir, const QString &pref, const float &r, const float &g, const float &b)
	Sauvegarde les composantes RGB d'une couleur, en float.Utilise la categorie specifiee. More...

void	getColor (const QString &pref, float &r, float &g, float &b)
	Charge les composantes RGB d'une couleur, en float.Utilise la categorie courante. More...

void	getColor (const QString &dir, const QString &pref, float &r, float &g, float &b)
	Charge les composantes RGB d'une couleur, en float. Utilise la categorie specifiee. More...

int	getLastModificationCode ()

std::vector< QString >	getPreferenceNames ()

Static Public Member Functions
static QString	uintToString (const unsigned int &val)

static QString	uintToString (const size_t &val)

static QString	uintToString (const unsigned long &val)

static QString	intToString (const int &val)

static QString	floatToString (const float &val)

static QString	doubleToString (const double &val)

Protected Attributes
ODirMap	_prefDirs
	Tableau associatif parametre/valeur. More...

QString	_curDir
	Le nom de la categorie courante. More...

QString	_xmlRootNodeName
	Nom du noeud root du fichier XML. More...

QString	_xmlParamNodeName
	Nom des noeuds des parametres du fichier XML. More...

Private Attributes
int	_nPreferenceModificationStamp

Detailed Description

Systeme de gestion des preferences.

Il offre un moyen pour conserver et recuperer des informations quelconques (a base de string tout de meme).

Son principe est d'associer simplement une chaine de caractere, le nom du parametre ou la cle, a une autre chaine, qui est la valeur associee au parametre ou a la cle.

Pendant l'execution, toutes ces valeurs sont stockees dans un tableau associatif de type map<string, string>. Actuellement le format de sauvegarde est le XML (par les methodes readXML et writeXML) mais il est tout a fait envisageable d'ajouter d'autres formats de sauvegarde, par exemple en fichier INI ou dans la base de registre de Windows.

Ce code devrait etre portable sans trop de modification.

Remarque : Cette implementation utilise l'API XML Xerces-C du XML Apache Project (http://xml.apache.org/).

Author: Projet_Tympan

Definition at line 83 of file OPreferenceManager.h.

Constructor & Destructor Documentation

◆ OPreferenceManager() [1/4]

OPreferenceManager::OPreferenceManager ( )

Constructeur par defaut.

Definition at line 39 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ OPreferenceManager() [2/4]

OPreferenceManager::OPreferenceManager ( const QString & currentDirectory )

Constructeur.

Definition at line 47 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ OPreferenceManager() [3/4]

OPreferenceManager::OPreferenceManager	(	const QString &	rootNodeName,
		const QString &	paramNodeName
	)

Constructeur.

Definition at line 55 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ OPreferenceManager() [4/4]

OPreferenceManager::OPreferenceManager	(	const QString &	rootNodeName,
		const QString &	paramNodeName,
		const QString &	currentDirectory
	)

Constructeur.

Definition at line 63 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ ~OPreferenceManager()

OPreferenceManager::~OPreferenceManager ( )

virtual

Destructeur.

Definition at line 72 of file OPreferenceManager.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ completePreferences()

void OPreferenceManager::completePreferences ( QString filePath )

Complete les prÃ©fÃ©rences utilisateur manquante avec les valeurs par dÃ©faut.

Parameters

filePath chemin vers le fichier contenant les valeurs par dÃ©faut

Definition at line 88 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ doubleToString()

QString OPreferenceManager::doubleToString ( const double & val )

static

Methode utilitaire. Convertit un double en string.

Definition at line 706 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ exists() [1/2]

bool OPreferenceManager::exists	(	const QString &	dir,
		const QString &	pref
	)

Test si une preference est presente dans le tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a tester.

Returns: true si la preference existe; false sinon.

Definition at line 269 of file OPreferenceManager.cpp.

◆ exists() [2/2]

bool OPreferenceManager::exists ( const QString & pref )

Test si une preference est presente dans le tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a tester.

Returns: true si la preference existe; false sinon.

Definition at line 264 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ floatToString()

QString OPreferenceManager::floatToString ( const float & val )

static

Methode utilitaire. Convertit un float en string.

Definition at line 696 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ getBool() [1/2]

bool OPreferenceManager::getBool	(	const QString &	dir,
		const QString &	pref
	)

Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 475 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ getBool() [2/2]

bool OPreferenceManager::getBool ( const QString & pref )

Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 470 of file OPreferenceManager.cpp.

◆ getColor() [1/2]

void OPreferenceManager::getColor	(	const QString &	dir,
		const QString &	pref,
		float &	r,
		float &	g,
		float &	b
	)

Charge les composantes RGB d'une couleur, en float. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
r	La composante rouge.
g	La composante verte.
b	La composante bleue.

Definition at line 634 of file OPreferenceManager.cpp.

◆ getColor() [2/2]

void OPreferenceManager::getColor	(	const QString &	pref,
		float &	r,
		float &	g,
		float &	b
	)

Charge les composantes RGB d'une couleur, en float.Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
r	La composante rouge.
g	La composante verte.
b	La composante bleue.

Definition at line 629 of file OPreferenceManager.cpp.

◆ getCurrentDirectory()

QString OPreferenceManager::getCurrentDirectory ( )

inline

Retourne la categorie courante pour la lecture et l'ecriture de parametres.

Returns: Le nom de la categorie courante.

Definition at line 208 of file OPreferenceManager.h.

◆ getDirectory()

QString OPreferenceManager::getDirectory ( const QString & pref )

Recherche le nom de la categorie pour une preference donnee.

Parameters

pref	Le nom de la preference a tester.

Returns: Le nom de la 1ere categorie dans laquelle se trouve le parametre recherche.

Definition at line 276 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ getDouble() [1/2]

double OPreferenceManager::getDouble	(	const QString &	dir,
		const QString &	pref
	)

Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 526 of file OPreferenceManager.cpp.

◆ getDouble() [2/2]

double OPreferenceManager::getDouble ( const QString & pref )

Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 521 of file OPreferenceManager.cpp.

◆ getFloat() [1/2]

float OPreferenceManager::getFloat	(	const QString &	dir,
		const QString &	pref
	)

Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 505 of file OPreferenceManager.cpp.

◆ getFloat() [2/2]

float OPreferenceManager::getFloat ( const QString & pref )

Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 500 of file OPreferenceManager.cpp.

◆ getFrame() [1/2]

void OPreferenceManager::getFrame	(	const QString &	dir,
		const QString &	pref,
		int &	posX,
		int &	posY,
		int &	sizeX,
		int &	sizeY
	)

Charge la position et la taille d'une fenetre. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.
posX	La position en X.
posY	La position en Y.
sizeX	La taille en X.
sizeY	La taille en Y.

Definition at line 552 of file OPreferenceManager.cpp.

◆ getFrame() [2/2]

void OPreferenceManager::getFrame	(	const QString &	pref,
		int &	posX,
		int &	posY,
		int &	sizeX,
		int &	sizeY
	)

Charge la position et la taille d'une fenetre. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.
posX	La position en X.
posY	La position en Y.
sizeX	La taille en X.
sizeY	La taille en Y.

Definition at line 547 of file OPreferenceManager.cpp.

◆ getInt() [1/2]

int OPreferenceManager::getInt	(	const QString &	dir,
		const QString &	pref
	)

Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 452 of file OPreferenceManager.cpp.

◆ getInt() [2/2]

int OPreferenceManager::getInt ( const QString & pref )

Recherche une ressource et retourne sa valeur associee.Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 447 of file OPreferenceManager.cpp.

◆ getLastModificationCode()

int OPreferenceManager::getLastModificationCode ( )

inline

Renvoie un nÂ° de version permettant de savoir si des valeurs ont ete modifiees

Definition at line 805 of file OPreferenceManager.h.

◆ getPoint() [1/2]

void OPreferenceManager::getPoint	(	const QString &	dir,
		const QString &	pref,
		int &	x,
		int &	y
	)

Charge les coordonnees en pixel d'un point. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.
x	La coordonnee X.
y	La coordonnee Y.

Definition at line 609 of file OPreferenceManager.cpp.

◆ getPoint() [2/2]

void OPreferenceManager::getPoint	(	const QString &	pref,
		int &	x,
		int &	y
	)

Charge les coordonnees en pixel d'un point. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.
x	La coordonnee X.
y	La coordonnee Y.

Definition at line 604 of file OPreferenceManager.cpp.

◆ getPreferenceNames()

std::vector< QString > OPreferenceManager::getPreferenceNames ( )

Returns the names of the user preferences

Definition at line 77 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ getString() [1/2]

QString OPreferenceManager::getString	(	const QString &	dir,
		const QString &	pref
	)

Recherche une ressource et retourne sa valeur associee. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 322 of file OPreferenceManager.cpp.

◆ getString() [2/2]

QString OPreferenceManager::getString ( const QString & pref )

Recherche une ressource et retourne sa valeur associee. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.

Returns: La valeur associee a la preference.

Definition at line 317 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ getStringArray() [1/2]

QString * OPreferenceManager::getStringArray	(	const QString &	dir,
		const QString &	pref,
		int &	sizeArray
	)

Recherche une ressource et retourne son tableau de valeurs associees. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference a rechercher.
sizeArray	Cet entier contiendra la taille du tableau retourne.

Returns: Un tableau contenant les valeurs associees a la preference. L'appelant de cette methode est responsable d'effacer ce tableau.

Definition at line 351 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ getStringArray() [2/2]

QString * OPreferenceManager::getStringArray	(	const QString &	pref,
		int &	sizeArray
	)

Recherche une ressource et retourne son tableau de valeurs associees. Utilise la categorie courante.

Parameters

pref	Le nom de la preference a rechercher.
sizeArray	Cet entier contiendra la taille du tableau retourne.

Returns: Un tableau contenant les valeurs associees a la preference. L'appelant de cette methode est responsable d'effacer ce tableau.

Definition at line 346 of file OPreferenceManager.cpp.

◆ intToString()

QString OPreferenceManager::intToString ( const int & val )

static

Methode utilitaire. Convertit un int en string.

Definition at line 688 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ loadDefault()

void OPreferenceManager::loadDefault	(	const char *	defaultParams[][2],
		int	nbParams
	)

Charge le tableau associatif preference/valeur avec les valeurs par defaut.

Parameters

defaultParams	Un tableau de couples preference/valeur.
nbParams	Le nombre de couples contenu dans le tableau passe.

Definition at line 107 of file OPreferenceManager.cpp.

◆ readXML()

bool OPreferenceManager::readXML ( QString fileName )

Ouvre un fichier de preference en XML et le parcours pour mettre a jour la tableau de preferences.

Parameters

fileName Le chemin du fichier de preferences a ouvrir.

Returns: false si le fichier n'a pas pu etre ouvert.

Definition at line 129 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ reset()

void OPreferenceManager::reset ( )

Vide le tableau associatif preference/valeur.

Definition at line 122 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ setBool() [1/2]

void OPreferenceManager::setBool	(	const QString &	dir,
		const QString &	pref,
		const bool &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 464 of file OPreferenceManager.cpp.

◆ setBool() [2/2]

void OPreferenceManager::setBool	(	const QString &	pref,
		const bool &	value
	)

Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 459 of file OPreferenceManager.cpp.

◆ setColor() [1/2]

void OPreferenceManager::setColor	(	const QString &	dir,
		const QString &	pref,
		const float &	r,
		const float &	g,
		const float &	b
	)

Sauvegarde les composantes RGB d'une couleur, en float.Utilise la categorie specifiee.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
r	La composante rouge.
g	La composante verte.
b	La composante bleue.

Definition at line 620 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setColor() [2/2]

void OPreferenceManager::setColor	(	const QString &	pref,
		const float &	r,
		const float &	g,
		const float &	b
	)

Sauvegarde les composantes RGB d'une couleur, en float.Utilise la categorie courante.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences.

Parameters

pref	Le nom de la preference.
r	La composante rouge.
g	La composante verte.
b	La composante bleue.

Definition at line 615 of file OPreferenceManager.cpp.

◆ setCurrentDirectory()

void OPreferenceManager::setCurrentDirectory ( QString dir )

Defini la categorie courante pour la lecture et l'ecriture de parametres.

Parameters

dir	Le nom de la categorie, si elle n'existe pas elle sera creee.

Definition at line 117 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ setDouble() [1/2]

void OPreferenceManager::setDouble	(	const QString &	dir,
		const QString &	pref,
		const double &	value
	)

Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 515 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setDouble() [2/2]

void OPreferenceManager::setDouble	(	const QString &	pref,
		const double &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 510 of file OPreferenceManager.cpp.

◆ setFloat() [1/2]

void OPreferenceManager::setFloat	(	const QString &	dir,
		const QString &	pref,
		const float &	value
	)

Met a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 494 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setFloat() [2/2]

void OPreferenceManager::setFloat	(	const QString &	pref,
		const float &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 489 of file OPreferenceManager.cpp.

◆ setFrame() [1/2]

void OPreferenceManager::setFrame	(	const QString &	dir,
		const QString &	pref,
		const int &	posX,
		const int &	posY,
		const int &	sizeX,
		const int &	sizeY
	)

Sauvegarde la position et la taille d'une fenetre.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
posX	La position en X.
posY	La position en Y.
sizeX	La taille en X.
sizeY	La taille en Y.

Definition at line 537 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setFrame() [2/2]

void OPreferenceManager::setFrame	(	const QString &	pref,
		const int &	posX,
		const int &	posY,
		const int &	sizeX,
		const int &	sizeY
	)

Sauvegarde la position et la taille d'une fenetre.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
posX	La position en X.
posY	La position en Y.
sizeX	La taille en X.
sizeY	La taille en Y.

Definition at line 531 of file OPreferenceManager.cpp.

◆ setInt() [1/2]

void OPreferenceManager::setInt	(	const QString &	dir,
		const QString &	pref,
		const int &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 441 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setInt() [2/2]

void OPreferenceManager::setInt	(	const QString &	pref,
		const int &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 436 of file OPreferenceManager.cpp.

◆ setPoint() [1/2]

void OPreferenceManager::setPoint	(	const QString &	dir,
		const QString &	pref,
		const int &	x,
		const int &	y
	)

Sauvegarde les coordonnees en pixel d'un point. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
x	La coordonnee X.
y	La coordonnee Y.

Definition at line 597 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setPoint() [2/2]

void OPreferenceManager::setPoint	(	const QString &	pref,
		const int &	x,
		const int &	y
	)

Sauvegarde les coordonnees en pixel d'un point.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
x	La coordonnee X.
y	La coordonnee Y.

Definition at line 592 of file OPreferenceManager.cpp.

◆ setString() [1/2]

void OPreferenceManager::setString	(	const QString &	dir,
		const QString &	pref,
		const QString &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 302 of file OPreferenceManager.cpp.

◆ setString() [2/2]

void OPreferenceManager::setString	(	const QString &	pref,
		const QString &	value
	)

Met a jour la valeur associee a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 297 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ setStringArray() [1/2]

void OPreferenceManager::setStringArray	(	const QString &	dir,
		const QString &	pref,
		const QString *	valueArray,
		const int &	sizeArray
	)

Met a jour un tableau de valeurs associees a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
valueArray	Le tableau de valeurs a associer a la preference.
sizeArray	Le nombre de valeurs contenues dans le tableau passe.

Definition at line 332 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setStringArray() [2/2]

void OPreferenceManager::setStringArray	(	const QString &	pref,
		const QString *	valueArray,
		const int &	sizeArray
	)

Met a jour un tableau de valeurs associees a une preference.

Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
valueArray	Le tableau de valeurs a associer a la preference.
sizeArray	Le nombre de valeurs contenues dans le tableau passe.

Definition at line 327 of file OPreferenceManager.cpp.

◆ setUInt() [1/6]

void OPreferenceManager::setUInt	(	const QString &	dir,
		const QString &	pref,
		const size_t &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 394 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setUInt() [2/6]

void OPreferenceManager::setUInt	(	const QString &	dir,
		const QString &	pref,
		const unsigned int &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 383 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setUInt() [3/6]

void OPreferenceManager::setUInt	(	const QString &	dir,
		const QString &	pref,
		const unsigned long &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie specifiee.

Parameters

dir	Le nom de la categorie.
pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 406 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setUInt() [4/6]

void OPreferenceManager::setUInt	(	const QString &	pref,
		const size_t &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 389 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setUInt() [5/6]

void OPreferenceManager::setUInt	(	const QString &	pref,
		const unsigned int &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 378 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ setUInt() [6/6]

void OPreferenceManager::setUInt	(	const QString &	pref,
		const unsigned long &	value
	)

Mets a jour la valeur associee a une preference. Si la preference n'existe pas, celle-ci est ajoutee au tableau de preferences. Utilise la categorie courante.

Parameters

pref	Le nom de la preference.
value	La valeur a associer a la preference.

Definition at line 401 of file OPreferenceManager.cpp.

Here is the call graph for this function:

◆ setXMLParamNodeName()

void OPreferenceManager::setXMLParamNodeName ( QString name )

inline

Change le nom des noeuds de parametres dans le fichier XML.

Parameters

name	Le nouveu nom du noeud.

Definition at line 143 of file OPreferenceManager.h.

Here is the caller graph for this function:

◆ setXMLRootNodeName()

void OPreferenceManager::setXMLRootNodeName ( QString name )

inline

Change le nom du noeud root du fichier XML.

Parameters

name	Le nouveu nom du noeud.

Definition at line 133 of file OPreferenceManager.h.

Here is the caller graph for this function:

◆ uintToString() [1/3]

QString OPreferenceManager::uintToString ( const size_t & val )

static

Methode utilitaire. Convertit un size_t en string.

Definition at line 654 of file OPreferenceManager.cpp.

◆ uintToString() [2/3]

QString OPreferenceManager::uintToString ( const unsigned int & val )

static

Methode utilitaire. Convertit un unsigned int en string.

Definition at line 646 of file OPreferenceManager.cpp.

Here is the caller graph for this function:

◆ uintToString() [3/3]

QString OPreferenceManager::uintToString ( const unsigned long & val )

static

Methode utilitaire. Convertit un unsigned long en string.

Definition at line 662 of file OPreferenceManager.cpp.

◆ writeXML()

bool OPreferenceManager::writeXML ( QString fileName )

Enregistre le fichier de preference au format XML.

Parameters

fileName Le chemin du fichier de preferences a enregistrer.

Returns: false si le fichier n'a pas pu etre enregistre.

Definition at line 205 of file OPreferenceManager.cpp.

Member Data Documentation

◆ _curDir

QString OPreferenceManager::_curDir

protected

Le nom de la categorie courante.

Definition at line 820 of file OPreferenceManager.h.

◆ _nPreferenceModificationStamp

int OPreferenceManager::_nPreferenceModificationStamp

private

Definition at line 828 of file OPreferenceManager.h.

◆ _prefDirs

ODirMap OPreferenceManager::_prefDirs

protected

Tableau associatif parametre/valeur.

Definition at line 817 of file OPreferenceManager.h.

◆ _xmlParamNodeName

QString OPreferenceManager::_xmlParamNodeName

protected

Nom des noeuds des parametres du fichier XML.

Definition at line 825 of file OPreferenceManager.h.

◆ _xmlRootNodeName

QString OPreferenceManager::_xmlRootNodeName

protected

Nom du noeud root du fichier XML.

Definition at line 823 of file OPreferenceManager.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/release-4.7.0/Tympan/models/business/OPreferenceManager.h
/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/release-4.7.0/Tympan/models/business/OPreferenceManager.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OPreferenceManager() [1/4]

◆ OPreferenceManager() [2/4]

◆ OPreferenceManager() [3/4]

◆ OPreferenceManager() [4/4]

◆ ~OPreferenceManager()

Member Function Documentation

◆ completePreferences()

◆ doubleToString()

◆ exists() [1/2]

◆ exists() [2/2]

◆ floatToString()

◆ getBool() [1/2]

◆ getBool() [2/2]

◆ getColor() [1/2]

◆ getColor() [2/2]

◆ getCurrentDirectory()

◆ getDirectory()

◆ getDouble() [1/2]

◆ getDouble() [2/2]

◆ getFloat() [1/2]

◆ getFloat() [2/2]

◆ getFrame() [1/2]

◆ getFrame() [2/2]

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getLastModificationCode()

◆ getPoint() [1/2]

◆ getPoint() [2/2]

◆ getPreferenceNames()

◆ getString() [1/2]

◆ getString() [2/2]

◆ getStringArray() [1/2]

◆ getStringArray() [2/2]

◆ intToString()

◆ loadDefault()

◆ readXML()

◆ reset()

◆ setBool() [1/2]

◆ setBool() [2/2]

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setCurrentDirectory()

◆ setDouble() [1/2]

◆ setDouble() [2/2]

◆ setFloat() [1/2]

◆ setFloat() [2/2]

◆ setFrame() [1/2]

◆ setFrame() [2/2]

◆ setInt() [1/2]

◆ setInt() [2/2]

◆ setPoint() [1/2]

◆ setPoint() [2/2]

◆ setString() [1/2]

◆ setString() [2/2]

◆ setStringArray() [1/2]

◆ setStringArray() [2/2]

◆ setUInt() [1/6]

◆ setUInt() [2/6]

◆ setUInt() [3/6]

◆ setUInt() [4/6]

◆ setUInt() [5/6]

◆ setUInt() [6/6]

◆ setXMLParamNodeName()

◆ setXMLRootNodeName()

◆ uintToString() [1/3]

◆ uintToString() [2/3]

◆ uintToString() [3/3]

◆ writeXML()

Member Data Documentation

◆ _curDir

◆ _nPreferenceModificationStamp

◆ _prefDirs

◆ _xmlParamNodeName

◆ _xmlRootNodeName