Source cleaning: tabs, whitespaces, -1/wxID_ANY, TRUE/true, FALSE/false.

[wxWidgets.git] / include / wx / msw / registry.h

diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h
index 134267eef0c57d176d4dd515ffc8e21c8e31c467..7075287295ec9fd74846663b87d56253339648cc 100644 (file)
--- a/include/wx/msw/registry.h
+++ b/include/wx/msw/registry.h
@@ -12,19 +12,10 @@
 #ifndef   _REGISTRY_H
 #define   _REGISTRY_H
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "registry.h"
 #endif
 
-// ----------------------------------------------------------------------------
-// mutable hack (see also registry.cpp)
-// ----------------------------------------------------------------------------
-#if   wxUSE_MUTABLE
-  #define MUTABLE mutable
-#else
-  #define MUTABLE
-#endif
-
 // ----------------------------------------------------------------------------
 // types used in this module
 // ----------------------------------------------------------------------------
@@ -41,7 +32,7 @@ typedef unsigned long ulong;
 // ----------------------------------------------------------------------------
 // class wxRegKey encapsulates window HKEY handle
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxRegKey 
+class WXDLLIMPEXP_BASE wxRegKey
 {
 public:
   // NB: do _not_ change the values of elements in these enumerations!
@@ -85,6 +76,13 @@ public:
 #endif  // Win32/16
   };
 
+  // access mode for the key
+  enum AccessMode
+  {
+      Read,     // read-only
+      Write     // read and write
+  };
+
   // information about standard (predefined) registry keys
     // number of standard keys
   static const size_t nStdKeys;
@@ -108,7 +106,7 @@ public:
   wxRegKey(StdKey keyParent, const wxString& strKey);
     // strKey is the name of key under (previously created) keyParent
   wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
-    //
+    // dtor closes the key
  ~wxRegKey();
 
   // change key (closes the previously opened key if any)
@@ -123,7 +121,7 @@ public:
 
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.
-  wxString GetName(bool bShortPrefix = TRUE) const;
+  wxString GetName(bool bShortPrefix = true) const;
     // return true if the key exists
   bool  Exists() const;
     // get the info about key (any number of these pointers may be NULL)
@@ -139,9 +137,9 @@ public:
   // operations on the key itself
     // explicitly open the key (will be automatically done by all functions
     // which need the key to be opened if the key is not opened yet)
-  bool  Open();
+  bool  Open(AccessMode mode = Write);
     // create the key: will fail if the key already exists and !bOkIfExists
-  bool  Create(bool bOkIfExists = TRUE);
+  bool  Create(bool bOkIfExists = true);
     // rename a value from old name to new one
   bool  RenameValue(const wxChar *szValueOld, const wxChar *szValueNew);
     // rename the key
@@ -168,7 +166,7 @@ public:
   // access to values and subkeys
     // get value type
   ValueType GetValueType(const wxChar *szValue) const;
-    // returns TRUE if the value contains a number (else it's some string)
+    // returns true if the value contains a number (else it's some string)
   bool IsNumericValue(const wxChar *szValue) const;
 
     // assignment operators set the default value of the key
@@ -177,19 +175,32 @@ public:
   wxRegKey& operator=(long lValue)
     { SetValue(NULL, lValue); return *this; }
 
-    // conversion operators query the default value of the key
-  operator wxString() const;
+    // query the default value of the key: implicitly or explicitly
+  wxString QueryDefaultValue() const;
+  operator wxString() const { return QueryDefaultValue(); }
+
+    // named values
 
     // set the string value
   bool  SetValue(const wxChar *szValue, const wxString& strValue);
-    // return the string value
-  bool  QueryValue(const wxChar *szValue, wxString& strValue) const;
+    // retrieve the string value
+  bool  QueryValue(const wxChar *szValue, wxString& strValue) const
+    { return QueryValue(szValue, strValue, false); }
+    // retrieve raw string value
+  bool  QueryRawValue(const wxChar *szValue, wxString& strValue) const
+    { return QueryValue(szValue, strValue, true); }
+    // retrieve either raw or expanded string value
+  bool  QueryValue(const wxChar *szValue, wxString& strValue, bool raw) const;
 
 #ifdef  __WIN32__
     // set the numeric value
   bool  SetValue(const wxChar *szValue, long lValue);
     // return the numeric value
   bool  QueryValue(const wxChar *szValue, long *plValue) const;
+    // set the binary value
+  bool  SetValue(const wxChar *szValue, const wxMemoryBuffer& buf);
+    // return the binary value
+  bool  QueryValue(const wxChar *szValue, wxMemoryBuffer& buf) const;
 #endif  //Win32
 
   // query existence of a key/value
@@ -211,7 +222,17 @@ public:
   bool  GetFirstKey  (wxString& strKeyName  , long& lIndex);
   bool  GetNextKey   (wxString& strKeyName  , long& lIndex) const;
 
+  // for wxRegConfig usage only: preallocate some memory for the name
+  void ReserveMemoryForName(size_t bytes) { m_strKey.reserve(bytes); }
+
 private:
+  // common part of all ctors
+  void Init()
+  {
+    m_hKey = (WXHKEY) NULL;
+    m_dwLastError = 0;
+  }
+
   // no copy ctor/assignment operator
   wxRegKey(const wxRegKey& key);            // not implemented
   wxRegKey& operator=(const wxRegKey& key); // not implemented
@@ -220,7 +241,7 @@ private:
               m_hRootKey;       // handle of the top key (i.e. StdKey)
   wxString    m_strKey;         // key name (relative to m_hRootKey)
 
-  MUTABLE long m_dwLastError;   // last error (0 if none)
+  long        m_dwLastError;    // last error (0 if none)
 };
 
 #endif  //_REGISTRY_H