]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/registry.h
Renamed internal GetClientWindow to GetClientAreaWindow so
[wxWidgets.git] / include / wx / msw / registry.h
index 693207b3fd31a4c6f9d2a4ab69ab6ee3b9568136..5e995ad25b8655741437a2592c2f80bcd7a713a9 100644 (file)
@@ -2,7 +2,7 @@
 // Name:        msw/registry.h
 // Purpose:     Registry classes and functions
 // Author:      Vadim Zeitlin
-// Modified by: 
+// Modified by:
 // Created:     03.04.198
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 #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
 // ----------------------------------------------------------------------------
@@ -56,7 +47,8 @@ public:
                                      // (with environment variable references)
     Type_Binary,                     // Free form binary
     Type_Dword,                      // 32-bit number
-    Type_Dword_little_endian,        // 32-bit number (same as Type_DWORD)
+    Type_Dword_little_endian         // 32-bit number
+        = Type_Dword,                // (same as Type_DWORD)
     Type_Dword_big_endian,           // 32-bit number
     Type_Link,                       // Symbolic Link (unicode)
     Type_Multi_String,               // Multiple Unicode strings
@@ -69,15 +61,17 @@ public:
   // predefined registry keys
   enum StdKey
   {
-    HKCR     // classes root
+    HKCR        // classes root
 #ifdef  __WIN32__
-    , HKCU,     // current user
-    HKLM,     // local machine
-    HKUSR,    // users
-    HKPD     // performance data (@@ NT only?)
-#if    WINVER >= 0x0400
-    , HKCC,     // current config
-    HKDD     // dynamic data
+    ,
+    HKCU,       // current user
+    HKLM,       // local machine
+    HKUSR,      // users
+    HKPD        // performance data (WinNT/2K only)
+#if WINVER >= 0x0400
+    ,
+    HKCC,       // current config (starting from Win95/NT 4.0)
+    HKDD        // dynamic data (Win95/98 only)
 #endif  // Winver
 #endif  // Win32/16
   };
@@ -124,18 +118,10 @@ public:
     // return true if the key exists
   bool  Exists() const;
     // get the info about key (any number of these pointers may be NULL)
-
-#ifdef __GNUWIN32__
   bool  GetKeyInfo(size_t *pnSubKeys,      // number of subkeys
                    size_t *pnMaxKeyLen,    // max len of subkey name
                    size_t *pnValues,       // number of values
                    size_t *pnMaxValueLen) const;
-#else
-  bool  GetKeyInfo(ulong *pnSubKeys,      // number of subkeys
-                   ulong *pnMaxKeyLen,    // max len of subkey name
-                   ulong *pnValues,       // number of values
-                   ulong *pnMaxValueLen) const;
-#endif
     // return true if the key is opened
   bool  IsOpened() const { return m_hKey != 0; }
     // for "if ( !key ) wxLogError(...)" kind of expressions
@@ -145,8 +131,20 @@ public:
     // 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();
-    // create the key: will fail if the key already exists and bOkIfExists
+    // create the key: will fail if the key already exists and !bOkIfExists
   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
+  bool  Rename(const wxChar *szNewName);
+    // copy value to another key possibly changing its name (by default it will
+    // remain the same)
+  bool  CopyValue(const wxChar *szValue, wxRegKey& keyDst,
+                  const wxChar *szNewName = NULL);
+    // copy the entire contents of the key recursively to another location
+  bool  Copy(const wxChar *szNewName);
+    // same as Copy() but using a key and not the name
+  bool  Copy(wxRegKey& keyDst);
     // close the key (will be automatically done in dtor)
   bool  Close();
 
@@ -170,13 +168,22 @@ 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
@@ -204,7 +211,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
@@ -213,7 +230,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