OILPreferences Class Reference

This class, like the Preferences class, is only ever instantiated once. It is a collection of routines to be used to handle the OIL side of reading and writing preferences. This class is used internally by the Preferences class - no other class should need to use it. More...

#include <oilprefs.h>

List of all members.

Public Member Functions
	OILPreferences (const wxString &appName=wxEmptyString, const wxString &vendorName=wxEmptyString, const wxString &localFilename=wxEmptyString, const wxString &globalFilename=wxEmptyString, longstyle=0, wxMBConv &conv=wxConvUTF8)
void	Write (LPTCHAR Section, LPTCHAR PrefName, PreferenceType Type, PrefData pData)
	This function writes a given preference out to the application's own initialisation (profile/preference) file.
void	Read (LPTCHAR Section, LPTCHAR PrefName, PreferenceType Type, PrefData pData)
	This function attempts to read the given preference in the given section from the preference file. No error is raised if the preference cannot be found, because this is a perfectly valid occurence - e.g. when a tool is being used for the first time, it has no preferences in the preference file.
BOOL	OpenInput ()
	Prepares the preference system for reading in preferences.
BOOL	CloseInput ()
	Performs clean-up necessary when the preferences file is no longer needed for reading.
BOOL	OpenOutput ()
	Prepares the OIL for writing preferences out to the preferences file.
BOOL	CloseOutput ()
	Closes the preference file when all the preferences have been written.
void	WipePreferenceFile ()
	Remove all entries from a preference file. This is done by deleting the file and creating a new one.
void	WipeDangerousPrefs ()
	Remove potentially dangerous entries from the registry.
Static Public Member Functions
static OILPreferences *	Init ()
	Performs any initialisation of the OIL layer preferences mechanisms that may fail.

---

Detailed Description

This class, like the Preferences class, is only ever instantiated once. It is a collection of routines to be used to handle the OIL side of reading and writing preferences. This class is used internally by the Preferences class - no other class should need to use it.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

24/8/93

See also:

Preferences

Definition at line 120 of file oilprefs.h.

---

Constructor & Destructor Documentation

OILPreferences::OILPreferences (  const wxString &  appName = wxEmptyString, const wxString &  vendorName = wxEmptyString, const wxString &  localFilename = wxEmptyString, const wxString &  globalFilename = wxEmptyString, long  style = 0, wxMBConv &  conv = wxConvUTF8 )  [inline]

Definition at line 128 of file oilprefs.h. : Correct*/ style = 0, wxMBConv& conv = wxConvUTF8) : wxConfig(appName, vendorName, localFilename, globalFilename, style, conv) {;}

---

Member Function Documentation

BOOL OILPreferences::CloseInput (   )

Performs clean-up necessary when the preferences file is no longer needed for reading. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Returns: TRUE if the input file was successfully closed, FALSE otherwise. Definition at line 378 of file oilprefs.cpp. { wxConfig::Set(NULL); return TRUE; }

BOOL OILPreferences::CloseOutput (   )

Closes the preference file when all the preferences have been written. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Returns: TRUE if the output file was successfully closeed, FALSE otherwise. Definition at line 413 of file oilprefs.cpp. { Flush(); return TRUE; }

OILPreferences * OILPreferences::Init (  void   )  [static]

Performs any initialisation of the OIL layer preferences mechanisms that may fail. Author: Luke_Hart & Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 8/Jun/2006 Returns: OILPreferences objects if initialisation succeeded, NULL otherwise. Definition at line 125 of file oilprefs.cpp. { wxStandardPaths Paths; wxString strPath( Paths.GetUserConfigDir() ); strPath += _T("/.xaralx"); // Delete any file that exists where the directory should be if (wxFile::Exists(strPath)) ::wxRemoveFile(strPath); // Create directory iff not exist if( !wxDir::Exists( strPath ) ) ::wxMkdir( strPath ); TRACEUSER( "jlh92", _T("OILPreferences::Init %s\n"), PCTSTR(strPath) ); // Open config storage strPath += _T("/preferences"); OILPreferences* pPrefs = new OILPreferences(_T("xaralx"), _T("Xara"), strPath); TRACEUSER( "jlh92", _T("OILPreferences::Init2 %s\n"), PCTSTR(strPath) ); // Return the object we made or a NULL pointer if we failed return pPrefs; }

BOOL OILPreferences::OpenInput (   )

Prepares the preference system for reading in preferences. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Returns: TRUE if the INT32 file was successfully opened, FALSE otherwise. Definition at line 358 of file oilprefs.cpp. { // Tell wxWidgets this is the default wxConfig object wxConfig::Set(this); return TRUE; }

BOOL OILPreferences::OpenOutput (   )

Prepares the OIL for writing preferences out to the preferences file. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Returns: TRUE if the output file was successfully opened, FALSE otherwise. Definition at line 397 of file oilprefs.cpp. { return TRUE; }

void OILPreferences::Read (  LPTCHAR  Section, LPTCHAR  PrefName, PreferenceType  Type, PrefData  pData )

This function attempts to read the given preference in the given section from the preference file. No error is raised if the preference cannot be found, because this is a perfectly valid occurence - e.g. when a tool is being used for the first time, it has no preferences in the preference file. TECHNICAL NOTES This function does not use the MFC GetProfileString() function becuase this returns a CString and we're trying to avoid these in Camelot. It uses the standard SDK function instead. Definition at line 294 of file oilprefs.cpp. { wxString strKey = _T("/Options/") + wxString(Section) + _T("/") + wxString(PrefName); switch (Type) { case PREF_INT: { // Use the value already in pData->Int as the value to return if the // preference is not found. /*TYPENOTE: Correct*/ long l; if (wxConfig::Read(strKey, &l)) *pData.pInt = (INT32)l; // Do not write directly as may be longer than 32 bits break; } case PREF_UINT: { // Note that signed value is read and cast directly into Unsigned memory // allocation reversing the effects fo the cast used in Write above... /*TYPENOTE: Correct*/ long l; if (wxConfig::Read(strKey, &l)) *pData.pUInt = (UINT32)l; // Do not write directly as may be longer than 32 bits break; } case PREF_DOUBLE: { // Get the textual version of the double and convert it to a double. // default to null string wxConfig::Read(strKey, (double*)(pData.pDouble)); break; } case PREF_STRING: { // Just get the string - need to ask for the address of the String's // text buffer so we can pass it to the SDK profile API. wxString str; if (wxConfig::Read(strKey, &str)) { str.Truncate(256); *(pData.pString) = (LPCTSTR)str; // *(pData.pString) = String_256(str); // use this form when StringBase derived classes support direct conversion } break; } default: ENSURE(FALSE, "OILPreferences::Read() called with an illegal preference type"); break; } }

void OILPreferences::WipeDangerousPrefs (   )

Remove potentially dangerous entries from the registry. Author: Chris_Gallimore (Xara Group Ltd) <camelotdev@xara.com> Date: 8/2/2001 Definition at line 177 of file oilprefs.cpp. { // wipe the potentially dangerous settings from the registry DeleteGroup(_T("Gallery")); DeleteGroup(_T("Options/Templates")); DeleteGroup(_T("Options/NewTemplates")); // DeleteRegKeyAndSubKeys (hAppStateRegKey, PRODUCT_REGISTRYKEY_GALLERY); // HKEY optsKey = OpenRegKey(hAppStateRegKey, PRODUCT_REGISTRYKEY_OPTIONS); // DeleteRegKeyAndSubKeys (optsKey, TEXT ("Templates")); // DeleteRegKeyAndSubKeys (optsKey, TEXT ("NewTemplates")); // CloseRegKey (optsKey); }

void OILPreferences::WipePreferenceFile (   )

Remove all entries from a preference file. This is done by deleting the file and creating a new one. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/11/93 Definition at line 162 of file oilprefs.cpp. { DeleteAll(); }

void OILPreferences::Write (  LPTCHAR  Section, LPTCHAR  PrefName, PreferenceType  Type, PrefData  Data )

This function writes a given preference out to the application's own initialisation (profile/preference) file. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/93 Parameters: Section  - Name of the section to write the preference into. [INPUTS] PrefName - Name of the preference itself. Type - Type of the preference (INT32, UINT32, etc.) Data - Union holding the pointer to the data to write out to the preference file. See also: OILPreferences; OILPreferences::Read Definition at line 209 of file oilprefs.cpp. { wxString strKey = _T("/Options/") + wxString(Section) + _T("/") + wxString(PrefName); BOOL Worked=FALSE; switch (Type) { case PREF_INT: { /*TYPENOTE: Correct*/ long l = (long)(*Data.pInt); Worked = wxConfig::Write(strKey, l); break; } case PREF_UINT: { // Note that unsigned cast to signed here will appear to store the wrong value // in the Config store but this apparent mistake will be rectified when the // value is read in and cast back to UINT32 again. // (Could write UINT32 prefs as strings...) // /*TYPENOTE: Correct*/ long l = (long)(*Data.pUInt); Worked = wxConfig::Write(strKey, l); break; } case PREF_DOUBLE: Worked = wxConfig::Write(strKey, (double)*(Data.pDouble)); break; case PREF_STRING: Worked = wxConfig::Write(strKey, wxString((TCHAR*)*(Data.pString))); // Worked = wxConfig::Write(strKey, *(Data.pString)); // use this form when StringBase derived classes support direct conversion break; default: ENSURE(FALSE, "OILPreferences::Write() called with an illegal preference type"); break; } if (!Worked) { ERROR3 ("Error saving preference - See trace message for details"); TRACE( _T("Error saving preference '%s'\n"), PrefName); } }

---

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

• wxOil/oilprefs.h (r1785/r1282)
• wxOil/oilprefs.cpp (r1785/r1466)

---