]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/registry.h
wxDropTarget starts to work
[wxWidgets.git] / include / wx / msw / registry.h
index adacf76944eff9323e3bd120e62a07dfe528625e..8f43954176a372e7f9a5d3e821aaadb5a29090c5 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 char *GetStdKeyName(size_t key);
     // get the short name of a standard key
-  static const char *GetStdKeyShortName(uint key);
+  static const char *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!)
@@ -93,23 +102,42 @@ public:
     // strKey is the full name of the key (i.e. starting with HKEY_xxx...)
   wxRegKey(const wxString& strKey);
     // strKey is the name of key under (standard key) keyParent
-  wxRegKey(StdKey          keyParent, const wxString& strKey);
+  wxRegKey(StdKey keyParent, const wxString& strKey);
     // strKey is the name of key under (previously created) keyParent
   wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
     //
  ~wxRegKey();
 
   // change key (closes the previously opened key if any)
+    // the name is absolute, i.e. should start with HKEY_xxx
   void  SetName(const wxString& strKey);
-  void  SetHkey(HKEY  hKey);
+    // the name is relative to the parent key
+  void  SetName(StdKey keyParent, const wxString& strKey);
+    // 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(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;
-    // return TRUE if the key is opened
-  bool  IsOpened() const { return m_hKey != 0;        }
+    // 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
   operator bool()  const { return m_dwLastError == 0; }
 
@@ -132,7 +160,9 @@ public:
 
   // access to values and subkeys
     // get value type
-  ValueType GetValueType(const char *szValue);
+  ValueType GetValueType(const char *szValue) const;
+    // returns TRUE if the value contains a number (else it's some string)
+  bool IsNumericValue(const char *szValue) const;
 
     // assignment operators set the default value of the key
   wxRegKey& operator=(const wxString& strValue)
@@ -155,16 +185,17 @@ public:
   bool  QueryValue(const char *szValue, long *plValue) const;
 #endif  //Win32
 
-    // return TRUE if given subkey exists
+  // query existence of a key/value
+    // return true if value exists
+  bool  HasValue(const char *szKey) const;
+    // return true if given subkey exists
   bool  HasSubKey(const char *szKey) const;
-    // return TRUE if any subkeys exist
+    // return true if any subkeys exist
   bool  HasSubkeys() const;
 
   // enumerate values and subkeys
-#ifdef  __WIN32__
   bool  GetFirstValue(wxString& strValueName, long& lIndex);
   bool  GetNextValue (wxString& strValueName, long& lIndex) const;
-#endif  //Win32
 
   bool  GetFirstKey  (wxString& strKeyName  , long& lIndex);
   bool  GetNextKey   (wxString& strKeyName  , long& lIndex) const;
@@ -174,7 +205,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)
 
@@ -182,3 +213,4 @@ private:
 };
 
 #endif  //_REGISTRY_H
+