]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/registry.h
test
[wxWidgets.git] / include / wx / msw / registry.h
index d7793ca0bc9556e383491dd6d3a64b3030ed7940..958b78c878df9fd6e4040a734577c875b5b907f4 100644 (file)
@@ -6,28 +6,37 @@
 // Created:     03.04.198
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _REGISTRY_H
 #define   _REGISTRY_H
 
+#ifdef __GNUG__
+#pragma interface "registry.h"
+#endif
+
 // ----------------------------------------------------------------------------
 // mutable hack (see also registry.cpp)
 // ----------------------------------------------------------------------------
-#if   USE_MUTABLE
+#if   wxUSE_MUTABLE
   #define MUTABLE mutable
 #else
   #define MUTABLE
 #endif
 
 // ----------------------------------------------------------------------------
-// forward decl for handle type
+// types used in this module
 // ----------------------------------------------------------------------------
+
+/*
 #ifndef   HKEY_DEFINED
   #define HKEY_DEFINED
   #define HKEY unsigned long
 #endif
+*/
+
+typedef unsigned long ulong;
 
 // ----------------------------------------------------------------------------
 // class wxRegKey encapsulates window HKEY handle
@@ -53,22 +62,22 @@ public:
     Type_Multi_String,               // Multiple Unicode strings
     Type_Resource_list,              // Resource list in the resource map
     Type_Full_resource_descriptor,   // Resource list in the hardware description
-    Type_Resource_requirements_list, // ???
+    Type_Resource_requirements_list  // ???
 #endif  //WIN32
   };
 
   // predefined registry keys
   enum StdKey
   {
-    HKCR,     // classes root
+    HKCR     // classes root
 #ifdef  __WIN32__
-    HKCU,     // current user
+    HKCU,     // current user
     HKLM,     // local machine
     HKUSR,    // users
-    HKPD,     // performance data (@@ NT only?)
+    HKPD     // performance data (@@ NT only?)
 #if    WINVER >= 0x0400
-    HKCC,     // current config
-    HKDD,     // dynamic data
+    HKCC,     // current config
+    HKDD     // dynamic data
 #endif  // Winver
 #endif  // Win32/16
   };
@@ -77,11 +86,11 @@ public:
     // number of standard keys
   static const size_t nStdKeys;
     // get the name of a standard key
-  static const char *GetStdKeyName(uint key);
+  static const wxChar *GetStdKeyName(size_t key);
     // get the short name of a standard key
-  static const char *GetStdKeyShortName(uint key);
+  static const wxChar *GetStdKeyShortName(size_t key);
     // get StdKey from root HKEY
-  static StdKey GetStdKeyFromHkey(HKEY hkey);
+  static StdKey GetStdKeyFromHkey(WXHKEY hkey);
 
   // extacts the std key prefix from the string (return value) and
   // leaves only the part after it (i.e. modifies the string passed!)
@@ -107,15 +116,28 @@ public:
     // the name is relative to the parent key
   void  SetName(const wxRegKey& keyParent, const wxString& strKey);
     // hKey should be opened and will be closed in wxRegKey dtor
-  void  SetHkey(HKEY hKey);
+  void  SetHkey(WXHKEY hKey);
 
   // get infomation about the key
     // get the (full) key name. Abbreviate std root keys if bShortPrefix.
   wxString GetName(bool bShortPrefix = TRUE) const;
     // return true if the key exists
-  bool  Exists()   const;
+  bool  Exists() const;
+    // get the info about key (any number of these pointers may be NULL)
+
+#if defined( __GNUWIN32__) && !defined(wxUSE_NORLANDER_HEADERS)
+  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;        }
+  bool  IsOpened() const { return m_hKey != 0; }
     // for "if ( !key ) wxLogError(...)" kind of expressions
   operator bool()  const { return m_dwLastError == 0; }
 
@@ -132,13 +154,15 @@ public:
     // deletes this key and all of it's subkeys/values
   bool  DeleteSelf();
     // deletes the subkey with all of it's subkeys/values recursively
-  bool  DeleteKey(const char *szKey);
+  bool  DeleteKey(const wxChar *szKey);
     // deletes the named value (may be NULL to remove the default value)
-  bool  DeleteValue(const char *szValue);
+  bool  DeleteValue(const wxChar *szValue);
 
   // access to values and subkeys
     // get value type
-  ValueType GetValueType(const char *szValue);
+  ValueType GetValueType(const wxChar *szValue) const;
+    // 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
   wxRegKey& operator=(const wxString& strValue)
@@ -150,24 +174,28 @@ public:
   operator wxString() const;
 
     // set the string value
-  bool  SetValue(const char *szValue, const wxString& strValue);
+  bool  SetValue(const wxChar *szValue, const wxString& strValue);
     // return the string value
-  bool  QueryValue(const char *szValue, wxString& strValue) const;
+  bool  QueryValue(const wxChar *szValue, wxString& strValue) const;
 
 #ifdef  __WIN32__
     // set the numeric value
-  bool  SetValue(const char *szValue, long lValue);
+  bool  SetValue(const wxChar *szValue, long lValue);
     // return the numeric value
-  bool  QueryValue(const char *szValue, long *plValue) const;
+  bool  QueryValue(const wxChar *szValue, long *plValue) const;
 #endif  //Win32
 
   // query existence of a key/value
     // return true if value exists
-  bool  HasValue(const char *szKey) const;
+  bool HasValue(const wxChar *szKey) const;
     // return true if given subkey exists
-  bool  HasSubKey(const char *szKey) const;
+  bool HasSubKey(const wxChar *szKey) const;
     // return true if any subkeys exist
-  bool  HasSubkeys() const;
+  bool HasSubkeys() const;
+    // return true if any values exist
+  bool HasValues() const;
+    // return true if the key is empty (nothing under this key)
+  bool IsEmpty() const { return !HasSubkeys() && !HasValues(); }
 
   // enumerate values and subkeys
   bool  GetFirstValue(wxString& strValueName, long& lIndex);
@@ -181,7 +209,7 @@ private:
   wxRegKey(const wxRegKey& key);            // not implemented
   wxRegKey& operator=(const wxRegKey& key); // not implemented
 
-  HKEY        m_hKey,           // our handle
+  WXHKEY      m_hKey,           // our handle
               m_hRootKey;       // handle of the top key (i.e. StdKey)
   wxString    m_strKey;         // key name (relative to m_hRootKey)