implement HitTest(pos) variant and not HitTest(x, y) one as this is what Windows...

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

diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h
index 23b507744f140c43ac8839b97697f997954eb28a..779847320485462b6d4364591532240b938af41a 100644 (file)
--- a/include/wx/msw/registry.h
+++ b/include/wx/msw/registry.h
@@ -2,37 +2,37 @@
 // Name:        msw/registry.h
 // Purpose:     Registry classes and functions
 // Author:      Vadim Zeitlin
 // 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>
 // 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
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _REGISTRY_H
 #define   _REGISTRY_H
 

-// ----------------------------------------------------------------------------
-// mutable hack (see also registry.cpp)
-// ----------------------------------------------------------------------------
-#if   USE_MUTABLE
-  #define MUTABLE mutable
-#else
-  #define MUTABLE
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma interface "registry.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------

-// forward decl for handle type
+// types used in this module

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

+
+/*

 #ifndef   HKEY_DEFINED
   #define HKEY_DEFINED
   #define HKEY unsigned long
 #endif
 #ifndef   HKEY_DEFINED
   #define HKEY_DEFINED
   #define HKEY unsigned long
 #endif

+*/
+
+typedef unsigned long ulong;

 
 // ----------------------------------------------------------------------------
 // class wxRegKey encapsulates window HKEY handle
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // 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!
 {
 public:
   // NB: do _not_ change the values of elements in these enumerations!


@@ -47,41 +47,51 @@ public:
                                      // (with environment variable references)
     Type_Binary,                     // Free form binary
     Type_Dword,                      // 32-bit number
                                      // (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
     Type_Resource_list,              // Resource list in the resource map
     Type_Full_resource_descriptor,   // Resource list in the hardware description
     Type_Dword_big_endian,           // 32-bit number
     Type_Link,                       // Symbolic Link (unicode)
     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
   {
 #endif  //WIN32
   };
 
   // predefined registry keys
   enum StdKey
   {

-    HKCR,     // classes root
+    HKCR        // classes root

 #ifdef  __WIN32__
 #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
   };
 
 #endif  // Winver
 #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;
     // get the name of a standard key
   // information about standard (predefined) registry keys
     // 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
     // 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
     // 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!)
 
   // extacts the std key prefix from the string (return value) and
   // leaves only the part after it (i.e. modifies the string passed!)


@@ -96,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);
   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)
  ~wxRegKey();
 
   // change key (closes the previously opened key if any)


@@ -107,24 +117,41 @@ 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
     // 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.
 
   // 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
     // 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)
+  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;

     // return true if the key is opened
     // 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; }
 
   // 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)
     // for "if ( !key ) wxLogError(...)" kind of expressions
   operator bool()  const { return m_dwLastError == 0; }
 
   // 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();
-    // create the key: will fail if the key already exists and bOkIfExists
-  bool  Create(bool bOkIfExists = true);
+  bool  Open(AccessMode mode = Write);
+    // 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();
 
     // close the key (will be automatically done in dtor)
   bool  Close();
 


@@ -132,13 +159,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
     // 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)
     // 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
 
   // 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)
 
     // assignment operators set the default value of the key
   wxRegKey& operator=(const wxString& strValue)


@@ -146,28 +175,45 @@ public:
   wxRegKey& operator=(long lValue)
     { SetValue(NULL, lValue); return *this; }
 
   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
 
     // set the string value

-  bool  SetValue(const char *szValue, const wxString& strValue);
-    // return the string value
-  bool  QueryValue(const char *szValue, wxString& strValue) const;
+  bool  SetValue(const wxChar *szValue, const wxString& strValue);
+    // 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
 
 #ifdef  __WIN32__
     // set the numeric value

-  bool  SetValue(const char *szValue, long lValue);
+  bool  SetValue(const wxChar *szValue, long lValue);

     // return the numeric value
     // return the numeric value

-  bool  QueryValue(const char *szValue, long *plValue) const;
+  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
     // return true if value exists
 #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
     // return true if given subkey exists

-  bool  HasSubKey(const char *szKey) const;
+  bool HasSubKey(const wxChar *szKey) const;

     // return true if any subkeys exist
     // 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);
 
   // enumerate values and subkeys
   bool  GetFirstValue(wxString& strValueName, long& lIndex);


@@ -176,16 +222,26 @@ public:
   bool  GetFirstKey  (wxString& strKeyName  , long& lIndex);
   bool  GetNextKey   (wxString& strKeyName  , long& lIndex) const;
 
   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:
 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
 
   // no copy ctor/assignment operator
   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)
 
               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
 };
 
 #endif  //_REGISTRY_H