X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12028905135250524409f1e7b9bfa9c55e5ce16b..644e896d3f855f2a85cc2f8bd1532b352cf30768:/include/wx/msw/registry.h diff --git a/include/wx/msw/registry.h b/include/wx/msw/registry.h index 5f4c818aa6..5f9020a7e7 100644 --- a/include/wx/msw/registry.h +++ b/include/wx/msw/registry.h @@ -1,38 +1,28 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: msw/registry.h +// Name: wx/msw/registry.h // Purpose: Registry classes and functions // Author: Vadim Zeitlin // Modified by: -// Created: 03.04.198 +// Created: 03.04.1998 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifndef _REGISTRY_H -#define _REGISTRY_H +#ifndef _WX_MSW_REGISTRY_H_ +#define _WX_MSW_REGISTRY_H_ #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "registry.h" #endif -// ---------------------------------------------------------------------------- -// types used in this module -// ---------------------------------------------------------------------------- - -/* -#ifndef HKEY_DEFINED - #define HKEY_DEFINED - #define HKEY unsigned long -#endif -*/ - -typedef unsigned long ulong; +class WXDLLIMPEXP_BASE wxOutputStream; // ---------------------------------------------------------------------------- // class wxRegKey encapsulates window HKEY handle // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_BASE wxRegKey + +class WXDLLIMPEXP_BASE wxRegKey { public: // NB: do _not_ change the values of elements in these enumerations! @@ -42,7 +32,6 @@ public: { Type_None, // No value type Type_String, // Unicode nul terminated string -#ifdef __WIN32__ Type_Expand_String, // Unicode nul terminated string // (with environment variable references) Type_Binary, // Free form binary @@ -55,25 +44,31 @@ public: Type_Resource_list, // Resource list in the resource map Type_Full_resource_descriptor, // Resource list in the hardware description Type_Resource_requirements_list // ??? -#endif //WIN32 }; // predefined registry keys enum StdKey { - HKCR // classes root -#ifdef __WIN32__ - , + HKCR, // classes root HKCU, // current user HKLM, // local machine - HKUSR, // users + HKUSR // users +#ifndef __WXWINCE__ + , HKPD // performance data (WinNT/2K only) +#endif #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 @@ -99,7 +94,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) @@ -114,7 +109,7 @@ 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) @@ -130,9 +125,9 @@ 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(); + bool Open(AccessMode mode = Write); // create the key: will fail if the key already exists and !bOkIfExists - bool Create(bool bOkIfExists = TRUE); + 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 @@ -159,7 +154,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 @@ -178,19 +173,21 @@ public: 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); } + { return QueryValue(szValue, strValue, false); } // retrieve raw string value bool QueryRawValue(const wxChar *szValue, wxString& strValue) const - { return QueryValue(szValue, strValue, TRUE); } + { 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; -#endif //Win32 + // set the binary value + bool SetValue(const wxChar *szValue, const wxMemoryBuffer& buf); + // return the binary value + bool QueryValue(const wxChar *szValue, wxMemoryBuffer& buf) const; // query existence of a key/value // return true if value exists @@ -211,6 +208,17 @@ public: bool GetFirstKey (wxString& strKeyName , long& lIndex); bool GetNextKey (wxString& strKeyName , long& lIndex) const; + // export the contents of this key and all its subkeys to the given file + // (which won't be overwritten, it's an error if it already exists) + // + // note that we export the key in REGEDIT4 format, not RegSaveKey() binary + // format nor newer REGEDIT5 one + bool Export(const wxString& filename) const; + + // same as above but write to the given (opened) stream + bool Export(wxOutputStream& ostr) const; + + // for wxRegConfig usage only: preallocate some memory for the name void ReserveMemoryForName(size_t bytes) { m_strKey.reserve(bytes); } @@ -222,16 +230,27 @@ private: m_dwLastError = 0; } - // no copy ctor/assignment operator - wxRegKey(const wxRegKey& key); // not implemented - wxRegKey& operator=(const wxRegKey& key); // not implemented + // recursive helper for Export() + bool DoExport(wxOutputStream& ostr) const; + + // export a single value + bool DoExportValue(wxOutputStream& ostr, const wxString& name) const; + + // return the text representation (in REGEDIT4 format) of the value with the + // given name + wxString FormatValue(const wxString& name) const; + WXHKEY m_hKey, // our handle m_hRootKey; // handle of the top key (i.e. StdKey) wxString m_strKey; // key name (relative to m_hRootKey) + AccessMode m_mode; // valid only if key is opened long m_dwLastError; // last error (0 if none) + + + DECLARE_NO_COPY_CLASS(wxRegKey) }; -#endif //_REGISTRY_H +#endif // _WX_MSW_REGISTRY_H_