Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_Preferences Class Reference

A class to manage preference data, using key/value paring.

List of all members.

Public Member Functions

Constructor / Destructor
 CP_Preferences (const CP_String &inApplicationID=kCP_CurrentApplicationID, bool inWriteToAnyUserDomain=false)
 Constructor.
 CP_Preferences (const CP_Preferences &inPreferences)
virtual ~CP_Preferences ()
 Destructor.
Getters
bool GetValue (const CP_String &inKey, bool *inOutValue)
bool GetValue (const CP_String &inKey, SInt16 *inOutValue)
bool GetValue (const CP_String &inKey, SInt32 *inOutValue)
bool GetValue (const CP_String &inKey, float *inOutValue)
bool GetValue (const CP_String &inKey, double *inOutValue)
bool GetValue (const CP_String &inKey, CP_Point *inOutValue)
bool GetValue (const CP_String &inKey, CP_Size *inOutValue)
bool GetValue (const CP_String &inKey, CP_Rect *inOutValue)
bool GetValue (const CP_String &inKey, CP_RGBColor *inOutValue)
bool GetValue (const CP_String &inKey, CP_String &inOutValue)
bool GetValue (const CP_String &inKey, char *inOutValue, SInt32 inMaxLength)
bool GetValue (const CP_String &inKey, CP_FileSystemSpec &inOutValue)
bool GetValue (const CP_String &inKey, CP_UUID &inOutValue)
bool GetValue (const CP_String &inKey, CP_DateTime &inOutValue)
Operators
CP_Preferences & operator= (const CP_Preferences &inPreferences)
Setters
bool SetValue (const CP_String &inKey, bool inOutValue)
bool SetValue (const CP_String &inKey, SInt16 inOutValue)
bool SetValue (const CP_String &inKey, SInt32 inOutValue)
bool SetValue (const CP_String &inKey, float inOutValue)
bool SetValue (const CP_String &inKey, double inOutValue)
bool SetValue (const CP_String &inKey, const CP_String &inValue)
bool SetValue (const CP_String &inKey, const char *inValue)
bool SetValue (const CP_String &inKey, const CP_Point &inValue)
bool SetValue (const CP_String &inKey, const CP_Size &inValue)
bool SetValue (const CP_String &inKey, const CP_Rect &inValue)
bool SetValue (const CP_String &inKey, const CP_RGBColor &inValue)
bool SetValue (const CP_String &inKey, const CP_FileSystemSpec &inValue)
bool SetValue (const CP_String &inKey, const CP_UUID &inValue)
bool SetValue (const CP_String &inKey, const CP_DateTime &inValue)

Protected Attributes

CP_String fApplicationID
bool fWriteToAnyUserDomain

Constructor & Destructor Documentation

CP_Preferences::CP_Preferences (  const CP_String &  inApplicationID = kCP_CurrentApplicationID,
bool  inWriteToAnyUserDomain = false
) 
 

Constructor.

CP_Preferences::CP_Preferences (  const CP_Preferences &  inPreferences  ) 
 

Constructor.

CP_Preferences::~CP_Preferences (   )  [virtual]
 

Constructor.

Todo:
what about error handling for non-debug?

Member Function Documentation

bool CP_Preferences::GetValue (  const CP_String &  inKey,
bool *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
SInt16 *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
SInt32 *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
float *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
double *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_Point *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_Size *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_Rect *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_RGBColor *  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_String &  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
char *  inOutValue,
SInt32  inMaxLength
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_FileSystemSpec &  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_UUID &  inOutValue
) 
 

bool CP_Preferences::GetValue (  const CP_String &  inKey,
CP_DateTime &  inOutValue
) 
 

CP_Preferences & CP_Preferences::operator= (  const CP_Preferences &  inPreferences  ) 
 

Assignment.

bool CP_Preferences::SetValue (  const CP_String &  inKey,
bool  inOutValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
SInt16  inOutValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
SInt32  inOutValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
float  inOutValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
double  inOutValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_String &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const char *  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_Point &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_Size &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_Rect &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_RGBColor &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_FileSystemSpec &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_UUID &  inValue
) 
 

bool CP_Preferences::SetValue (  const CP_String &  inKey,
const CP_DateTime &  inValue
) 
 

Member Data Documentation

CP_String CP_Preferences::fApplicationID [protected]
 

bool CP_Preferences::fWriteToAnyUserDomain [protected]
 

Application identifier used to store / find preference data.

The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:21:58 2005 for CPLAT_MacOS by  doxygen 1.4.0