X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/92049cd473c81fbce934e71796b2d841d5e605fa..8bf57c4f2eebf2d2988d6f573066164bcbaabe64:/include/wx/msw/registry.h diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h index 693207b3fd..7075287295 100644 --- a/include/wx/msw/registry.h +++ b/include/wx/msw/registry.h @@ -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 @@ -12,19 +12,10 @@ #ifndef _REGISTRY_H #define _REGISTRY_H -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #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 // ---------------------------------------------------------------------------- @@ -41,7 +32,7 @@ typedef unsigned long ulong; // ---------------------------------------------------------------------------- // 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! @@ -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,19 +61,28 @@ 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 }; + // 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; @@ -105,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); - // + // dtor closes the key ~wxRegKey(); // change key (closes the previously opened key if any) @@ -120,22 +121,14 @@ public: // 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 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 @@ -144,9 +137,21 @@ public: // 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(); @@ -161,7 +166,7 @@ public: // access to values and subkeys // get value type ValueType GetValueType(const wxChar *szValue) const; - // returns TRUE if the value contains a number (else it's some string) + // 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 @@ -170,19 +175,32 @@ 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 bool SetValue(const wxChar *szValue, long lValue); // return the numeric value 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 @@ -204,7 +222,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 +241,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