X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bda0e173844e8e0f8acf4e8ad8b5c26e5c6fe5d..d2ce649bec85c2c0764a0f786d2b1ef444321404:/include/wx/msw/registry.h diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h index adacf76944..76980b5f64 100644 --- a/include/wx/msw/registry.h +++ b/include/wx/msw/registry.h @@ -2,32 +2,32 @@ // 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 -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _REGISTRY_H #define _REGISTRY_H -// ---------------------------------------------------------------------------- -// mutable hack (see also registry.cpp) -// ---------------------------------------------------------------------------- -#if USE_MUTABLE - #define MUTABLE mutable -#else - #define MUTABLE +#ifdef __GNUG__ +#pragma interface "registry.h" #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 @@ -47,28 +47,31 @@ 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 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 - 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 }; @@ -77,11 +80,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!) @@ -93,23 +96,34 @@ 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) + 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 + bool IsOpened() const { return m_hKey != 0; } // for "if ( !key ) wxLogError(...)" kind of expressions operator bool() const { return m_dwLastError == 0; } @@ -117,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(); @@ -126,13 +152,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) @@ -144,41 +172,63 @@ public: operator wxString() const; // 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 - 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 - // return TRUE if given subkey exists - bool HasSubKey(const char *szKey) const; - // return TRUE if any subkeys exist - bool HasSubkeys() const; + // query existence of a key/value + // return true if value exists + bool HasValue(const wxChar *szKey) const; + // return true if given subkey exists + bool HasSubKey(const wxChar *szKey) const; + // return true if any subkeys exist + 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 -#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; + // 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 - 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) - MUTABLE long m_dwLastError; // last error (0 if none) + long m_dwLastError; // last error (0 if none) }; #endif //_REGISTRY_H +