Navigation

← Previous Changeset
Next Changeset →

Changeset 213

Timestamp:

02/07/08 16:28:56 (4 years ago)

Author:

uncle_fungus

Message:

doxygenated preferenceManager

Files:

branches/2.3.2beta3/src/include/preferencesManager.h (modified) (15 diffs)
branches/2.3.2beta3/src/preferencesManager.cpp (modified) (16 diffs)

Legend:

: Unmodified
: Added
: Removed
: Modified
: Copied
: Moved

branches/2.3.2beta3/src/include/preferencesManager.h

r38	r213
15	15	*/
16	16
	17	/**
	18	* \file preferencesManager.h
	19	* Manages stored preferences.
	20	* \author François Ingelrest
	21	* \author Andrew Schofield
	22	**/
	23
17	24	#ifndef _PREFERENCESMANAGER_H
18	25	#define _PREFERENCESMANAGER_H
…	…
22	29	#include "preference.h"
23	30
24
25		// Macros for retrieving preferences
26		// They 'return' the default value if the pref is unknown
	31	/**
	32	* Macro to get string preference.
	33	**/
27	34	#define _PrefsGetString(PREF_NAME, VAR_NAME) \
28	35	{ \
…	…
31	38	}
32	39
	40	/**
	41	* Macro to get hidden string preference.
	42	**/
33	43	#define _PrefsGetHiddenString(PREF_NAME, VAR_NAME) \
34	44	{ \
…	…
37	47	}
38	48
	49	/**
	50	* Macro to get unsigned integer preference.
	51	**/
39	52	#define _PrefsGetUint(PREF_NAME, VAR_NAME) \
40	53	{ \
…	…
43	56	}
44	57
	58	/**
	59	* Macro to get signed integer preference.
	60	**/
45	61	#define _PrefsGetInt(PREF_NAME, VAR_NAME) \
46	62	{ \
…	…
49	65	}
50	66
	67	/**
	68	* Macro to get double preference.
	69	**/
51	70	#define _PrefsGetDouble(PREF_NAME, VAR_NAME) \
52	71	{ \
…	…
55	74	}
56	75
	76	/**
	77	* Macro to get boolean preference.
	78	**/
57	79	#define _PrefsGetBool(PREF_NAME, VAR_NAME) \
58	80	{ \
…	…
61	83	}
62	84
63
64		// Macros for setting preferences
	85	/**
	86	* Macro to set string preference.
	87	**/
65	88	#define _PrefsSetString(PREF_NAME, VAR_NAME) \
66	89	{ \
…	…
68	91	}
69	92
	93	/**
	94	* Macro to set hidden string preference.
	95	**/
70	96	#define _PrefsSetHiddenString(PREF_NAME, VAR_NAME) \
71	97	{ \
…	…
73	99	}
74	100
	101	/**
	102	* Macro to set unsigned integer preference.
	103	**/
75	104	#define _PrefsSetUint(PREF_NAME, VAR_NAME) \
76	105	{ \
…	…
78	107	}
79	108
	109	/**
	110	* Macro to set signed integer preference.
	111	**/
80	112	#define _PrefsSetInt(PREF_NAME, VAR_NAME) \
81	113	{ \
…	…
83	115	}
84	116
	117	/**
	118	* Macro to set double preference.
	119	**/
85	120	#define _PrefsSetDouble(PREF_NAME, VAR_NAME) \
86	121	{ \
…	…
88	123	}
89	124
	125	/**
	126	* Macro to set boolean preference.
	127	**/
90	128	#define _PrefsSetBool(PREF_NAME, VAR_NAME) \
91	129	{ \
…	…
94	132
95	133
96		WX_DECLARE_STRING_HASH_MAP(Preference*, PreferencesHashMap);
97
98
99		/**
100		* This is the component which manages the configuration
101		* It's a singleton
102		**/
	134	WX_DECLARE_STRING_HASH_MAP(Preference, PreferencesHashMap); /< Hashmap to store preferences /
	135
	136
	137	/**
	138	* This class manages the configuration settings.
	139	* This class can only be instantiated once.
	140	**/
103	141	class PreferencesManager
104	142	{
105	143	protected:
106		PreferencesHashMap mPrefsHashMap;
107		static PreferencesManager *mInstance;
108
	144	PreferencesHashMap mPrefsHashMap; /*< The preference hashmap /
	145	static PreferencesManager mInstance; /< The single instance of the PreferencesManager /
	146
	147	/**
	148	* Contructor.
	149	**/
109	150	PreferencesManager(void);
	151
	152	/**
	153	* Destructor.
	154	**/
110	155	~PreferencesManager(void);
111	156
	157	/**
	158	* Change/set the value of a preference.
	159	* @param preference The preference to set.
	160	**/
112	161	void SetPref(Preference* preference);
	162
	163	/**
	164	* Retrieve the value of a preference.
	165	**/
113	166	Preference* GetPref(const wxString& name);
114	167
	168	/**
	169	* Load the preferences from the disk.
	170	**/
115	171	void Load(void);
116	172
…	…
118	174	public:
119	175	// Singleton pattern
	176	/**
	177	* Create the single instance of the PreferencesManager.
	178	**/
120	179	static void CreateInstance(void);
	180
	181	/**
	182	* Destroy the single instance of the PreferencesManager
	183	**/
121	184	static void DestroyInstance(void);
	185
	186	/**
	187	* Return the single instance of the PreferencesManager
	188	**/
122	189	static PreferencesManager* GetInstance(void);
	190
	191	/**
	192	* Save all the preferences to the disk.
	193	**/
123	194	void Save(void);
124	195
125	196	// Preferences management
126		// All the GetXXX() methods return a boolean, indicating if the preference could be retrieve or not
	197	// All the GetXXX() methods return a boolean, indicating if the preference could be retrieved or not
	198	/**
	199	* Set the value of a boolean preference.
	200	* @param name Preference name
	201	* @param value Value to retrieve
	202	**/
127	203	void SetBool(const wxString& name, bool value) {SetPref(new Preference(name, value));}
	204
	205	/**
	206	* Retrieve the value of a boolean preference.
	207	* @param name Preference name
	208	* @param value Value to retrieve
	209	**/
128	210	bool GetBool(const wxString& name, bool& value);
129	211
	212	/**
	213	* Set the value of a unsigned int preference.
	214	* @param name Preference name
	215	* @param value Value to retrieve
	216	**/
130	217	void SetUint(const wxString& name, wxUint32 value) {SetPref(new Preference(name, value));}
	218
	219	/**
	220	* Retrieve the value of an unsigned int preference.
	221	* @param name Preference name
	222	* @param value Value to retrieve
	223	**/
131	224	bool GetUint(const wxString& name, wxUint32& value);
132	225
	226	/**
	227	* Set the value of a signed int preference.
	228	* @param name Preference name
	229	* @param value Value to retrieve
	230	**/
133	231	void SetInt(const wxString& name, wxInt32 value) {SetPref(new Preference(name, value));}
	232
	233	/**
	234	* Retrieve the value of an signed int preference.
	235	* @param name Preference name
	236	* @param value Value to retrieve
	237	**/
134	238	bool GetInt(const wxString& name, wxInt32& value);
135	239
	240	/**
	241	* Set the value of a double preference.
	242	* @param name Preference name
	243	* @param value Value to retrieve
	244	**/
136	245	void SetDouble(const wxString& name, double value) {SetPref(new Preference(name, value));}
	246
	247	/**
	248	* Retrieve the value of a double preference.
	249	* @param name Preference name
	250	* @param value Value to retrieve
	251	**/
137	252	bool GetDouble(const wxString& name, double& value);
138	253
	254	/**
	255	* Set the value of a string preference.
	256	* @param name Preference name
	257	* @param value Value to retrieve
	258	**/
139	259	void SetString(const wxString& name, const wxString& value) {SetPref(new Preference(name, value));}
	260
	261	/**
	262	* Retrieve the value of a string preference.
	263	* @param name Preference name
	264	* @param value Value to retrieve
	265	**/
140	266	bool GetString(const wxString& name, wxString& value);
141	267
	268	/**
	269	* Set the value of a hidden string preference.
	270	* @param name Preference name
	271	* @param value Value to retrieve
	272	**/
142	273	void SetHiddenString(const wxString& name, const wxString& value) {SetPref(new Preference(name, value, true));}
	274
	275	/**
	276	* Retrieve the value of an hidden string preference.
	277	* @param name Preference name
	278	* @param value Value to retrieve
	279	**/
143	280	bool GetHiddenString(const wxString& name, wxString& value);
144	281	};

branches/2.3.2beta3/src/preferencesManager.cpp

r148	r213
15	15	*/
16	16
	17	/**
	18	* \file preferencesManager.cpp
	19	* Manages stored preferences.
	20	* \author François Ingelrest
	21	* \author Andrew Schofield
	22	**/
	23
17	24	#include "fahmon.h"
18	25	#include "preferencesManager.h"
…	…
29	36
30	37
31		/**
32		* Constructor
33		**/
34	38	PreferencesManager::PreferencesManager(void)
35	39	{
…	…
37	41
38	42
39		/**
40		* Destructor
41		**/
42	43	PreferencesManager::~PreferencesManager(void)
43	44	{
…	…
45	46
46	47
47		/**
48		* Create the single instance of the PreferencesManager
49		**/
50	48	void PreferencesManager::CreateInstance(void)
51	49	{
…	…
57	55
58	56
59		/**
60		* Destroy the single instance of the PreferencesManager
61		**/
62	57	void PreferencesManager::DestroyInstance(void)
63	58	{
…	…
71	66
72	67
73		/**
74		* Return the single instance of the PreferencesManager
75		**/
76	68	PreferencesManager* PreferencesManager::GetInstance(void)
77	69	{
…	…
82	74
83	75
84		/**
85		* Change/set the value of a preference
86		**/
87	76	void PreferencesManager::SetPref(Preference* preference)
88	77	{
…	…
103	92
104	93
105		/**
106		* Retrieve the value of a preference
107		**/
108	94	inline Preference* PreferencesManager::GetPref(const wxString& name)
109	95	{
…	…
119	105
120	106
121		/**
122		* Retrieve the value of a boolean preference
123		**/
124	107	bool PreferencesManager::GetBool(const wxString& name, bool& value)
125	108	{
…	…
138	121
139	122
140		/**
141		* Retrieve the value of an unsigned int preference
142		**/
143	123	bool PreferencesManager::GetUint(const wxString& name, wxUint32& value)
144	124	{
…	…
157	137
158	138
159		/**
160		* Retrieve the value of an signed int preference
161		**/
162	139	bool PreferencesManager::GetInt(const wxString& name, wxInt32& value)
163	140	{
…	…
176	153
177	154
178		/**
179		* Retrieve the value of a double preference
180		**/
181	155	bool PreferencesManager::GetDouble(const wxString& name, double& value)
182	156	{
…	…
195	169
196	170
197		/**
198		* Retrieve the value of a string preference
199		**/
200	171	bool PreferencesManager::GetString(const wxString& name, wxString& value)
201	172	{
…	…
214	185
215	186
216		/**
217		* Retrieve the value of an hidden string preference
218		**/
219	187	bool PreferencesManager::GetHiddenString(const wxString& name, wxString& value)
220	188	{
…	…
233	201
234	202
235		/**
236		* Load the preferences from the disk
237		**/
238	203	inline void PreferencesManager::Load(void)
239	204	{
…	…
260	225
261	226
262		/**
263		* Save all the preferences to the disk
264		**/
265	227	inline void PreferencesManager::Save(void)
266	228	{

Navigation

Changeset 213

Legend:

branches/2.3.2beta3/src/include/preferencesManager.h

branches/2.3.2beta3/src/preferencesManager.cpp

Download in other formats: