ALPreferences allows access to xml preference files.
A preference is defined as follows :
pParams[0] Name of the preference;
pParams[1] Description of the preference;
pParams[2] The value of the preference (can contain other preferences);
pParams[3] (optional) The name of the data when inserted into memory.
AL::ALValue readPrefFile (const string& fileName, const bool& autoGenerateMemoryNames)
Reads all preferences from an xml files and stores them in an ALValue.
Name of the module associate to the preference.
If true a memory name will be generated for each non-array preference.
array reprenting the whole file.
void writePrefFile (const string& fileName, const AL::ALValue& prefs, const bool& ignoreMemoryNames)
Writes all preferences from ALValue to an xml file.
Name of the module associate to the preference.
array reprenting the whole file.
If true all memory names will be removed before saving.
bool saveToMemory (const AL::ALValue& prefs)
Writes all preferences from ALValue to an xml file.
array reprenting the whole file.
True upon success.
string version ()
Returns the version of the module.
A string containing the version of the module.
AL::ALValue getMethodHelp (const string& methodName)
Retrieves a method's description.
The name of the method.
A structure containing the method's description.
AL::ALValue getModuleHelp ()
Retrieves the module's description.
A structure describing the module.
string getUsage (const string& name)
Gets the method usage string. This summarise how to use the method.
The name of the method.
A string that summarises the usage of the method.