synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/msw/iniconf.h b/include/wx/msw/iniconf.h
index c8d2544d658923f98ba50ade1219ab25a411db12..e65baba61da1416944847d3347658d3e74cfcd6e 100644 (file)
--- a/include/wx/msw/iniconf.h
+++ b/include/wx/msw/iniconf.h
@@ -1,16 +1,20 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        include/wx/msw/iniconf.h
+// Name:        wx/msw/iniconf.h
 // Purpose:     INI-file based wxConfigBase implementation
 // Author:      Vadim Zeitlin
-// Modified by: 
+// Modified by:
 // Created:     27.07.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#ifndef   _INICONF_H
-#define   _INICONF_H
+#ifndef   _WX_MSW_INICONF_H_
+#define   _WX_MSW_INICONF_H_
+
+#include "wx/defs.h"
+
+#if wxUSE_CONFIG && wxUSE_INICONF
 
 // ----------------------------------------------------------------------------
 // wxIniConfig is a wxConfig implementation which uses MS Windows INI files to
@@ -36,14 +40,15 @@
 // same as appname). The file name (strAppName parameter) may, in fact,
 // contain the full path to the file. If it doesn't, the file is searched for
 // in the Windows directory.
-class wxIniConfig : public wxConfigBase
+class WXDLLIMPEXP_CORE wxIniConfig : public wxConfigBase
 {
 public:
   // ctor & dtor
     // if strAppName doesn't contain the extension and is not an absolute path,
     // ".ini" is appended to it. if strVendor is empty, it's taken to be the
     // same as strAppName.
-  wxIniConfig(const wxString& strAppName, const wxString& strVendor = "");
+  wxIniConfig(const wxString& strAppName = wxEmptyString, const wxString& strVendor = wxEmptyString,
+    const wxString& localFilename = wxEmptyString, const wxString& globalFilename = wxEmptyString, long style = wxCONFIG_USE_LOCAL_FILE);
   virtual ~wxIniConfig();
 
   // implement inherited pure virtual functions
@@ -55,38 +60,47 @@ public:
   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
 
-  virtual uint GetNumberOfEntries(bool bRecursive = FALSE) const;
-  virtual uint GetNumberOfGroups(bool bRecursive = FALSE) const;
+  virtual size_t GetNumberOfEntries(bool bRecursive = false) const;
+  virtual size_t GetNumberOfGroups(bool bRecursive = false) const;
 
   virtual bool HasGroup(const wxString& strName) const;
   virtual bool HasEntry(const wxString& strName) const;
 
-  // return TRUE if the current group is empty
+  // return true if the current group is empty
   bool IsEmpty() const;
 
-  virtual bool Read(wxString *pstr, const char *szKey,
-                    const char *szDefault = 0) const;
-  virtual const char *Read(const char *szKey,
-                           const char *szDefault = 0) const;
-  virtual bool Read(long *pl, const char *szKey, long lDefault) const;
-  virtual long Read(const char *szKey, long lDefault) const;
-  virtual bool Write(const char *szKey, const char *szValue);
-  virtual bool Write(const char *szKey, long lValue);
-  virtual bool Flush(bool bCurrentOnly = FALSE);
-
-  virtual bool DeleteEntry(const char *szKey, bool bGroupIfEmptyAlso);
-  virtual bool DeleteGroup(const char *szKey);
+  virtual bool Flush(bool bCurrentOnly = false);
+
+  virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
+  virtual bool RenameGroup(const wxString& oldName, const wxString& newName);
+
+  virtual bool DeleteEntry(const wxString& Key, bool bGroupIfEmptyAlso = true);
+  virtual bool DeleteGroup(const wxString& szKey);
   virtual bool DeleteAll();
 
+protected:
+  // read/write
+  bool DoReadString(const wxString& key, wxString *pStr) const;
+  bool DoReadLong(const wxString& key, long *plResult) const;
+  bool DoReadBinary(const wxString& key, wxMemoryBuffer *buf) const;
+
+  bool DoWriteString(const wxString& key, const wxString& szValue);
+  bool DoWriteLong(const wxString& key, long lValue);
+  bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf);
+
 private:
   // helpers
-  wxString GetPrivateKeyName(const char *szKey) const;
-  wxString GetKeyName(const char *szKey) const;
+  wxString GetPrivateKeyName(const wxString& szKey) const;
+  wxString GetKeyName(const wxString& szKey) const;
 
-  wxString m_strAppName,  // name of the private INI file
-           m_strVendor;   // name of our section in WIN.INI
+  wxString m_strLocalFilename;  // name of the private INI file
   wxString m_strGroup,    // current group in appname.ini file
            m_strPath;     // the rest of the path (no trailing '_'!)
+
+  wxDECLARE_NO_COPY_CLASS(wxIniConfig);
+  DECLARE_ABSTRACT_CLASS(wxIniConfig)
 };
 
-#endif  //_INICONF_H
\ No newline at end of file
+#endif // wxUSE_CONFIG && wxUSE_INICONF
+
+#endif // _WX_MSW_INICONF_H_