]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/confbase.h
More wxMotif work, OGL enhancements, USE_ macro corrections, object.cpp delete
[wxWidgets.git] / include / wx / confbase.h
index eac77600e54eb34f6574560b0a4de6777bc997e4..af05537a6ce793f02600a247932b10709b8a2354 100644 (file)
@@ -23,9 +23,9 @@
 // ----------------------------------------------------------------------------
 
 // it won't compile without it anyhow
-#ifndef USE_WXCONFIG
-  #error "Please define USE_WXCONFIG or remove config.cpp from your makefile"
-#endif // USE_WXCONFIG
+#ifndef wxUSE_CONFIG
+  #error "Please define wxUSE_CONFIG or remove config.cpp from your makefile"
+#endif // wxUSE_CONFIG
 
 // ----------------------------------------------------------------------------
 // constants
   #define wxCONFIG_WIN32_NATIVE          TRUE
 #endif
 
+// Style flags for constructor style parameter
+#define wxCONFIG_USE_LOCAL_FILE         1
+#define wxCONFIG_USE_GLOBAL_FILE        2
+
 // ----------------------------------------------------------------------------
 // various helper global functions
 // ----------------------------------------------------------------------------
@@ -101,7 +105,17 @@ public:
 
   // ctor & virtual dtor
     // environment variable expansion is on by default
-  wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
+//  wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; }
+
+  // ctor
+
+  // Not all args will always be used by derived classes, but
+  // including them all in each class ensures compatibility.
+  // If appName is empty, uses wxApp name
+  wxConfigBase(const wxString& appName = "", const wxString& vendorName = "",
+               const wxString& localFilename = "", const wxString& globalFilename = "",
+               long style = 0);
+
     // empty but ensures that dtor of all derived classes is virtual
   virtual ~wxConfigBase() { }
 
@@ -138,31 +152,44 @@ public:
   // key access: returns TRUE if value was really read, FALSE if default used
   // (and if the key is not found the default value is returned.)
     // read a string from the key
-  virtual bool Read(wxString *pStr, const char *szKey,
-                    const char *szDefault = (const char *) NULL) const = 0;
-    // another version using statis buffer - it means it will be overwritten
-    // after each call to this function!
-  virtual const char *Read(const char *szKey,
-                           const char *szDefault = (const char *) NULL) const;
-    // the same for longs
-  virtual long Read(const char *szKey, long lDefault) const
-    { long l; Read(&l, szKey, lDefault); return l; }
-    // and another version: returns true if default value is returned
-  virtual bool Read(long *pl, const char *szKey, long lDefault = 0) const = 0;
+  virtual bool Read(const wxString& key, wxString *pStr) const = 0;
+  virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const;
+
+  virtual wxString Read(const wxString& key, const wxString& defVal = "") const;
+
+  virtual bool Read(const wxString& key, long *pl) const = 0;
+  virtual bool Read(const wxString& key, long *pl, long defVal) const;
+
+  virtual long Read(const wxString& strKey, long defVal) const
+    { long l; Read(strKey, &l, defVal); return l; }
+
+  // Convenience functions that are built on other forms
+  // double
+  virtual bool Read(const wxString& key, double* val) const;
+  virtual bool Read(const wxString& key, double* val, double defVal) const;
+
+  // bool
+  virtual bool Read(const wxString& key, bool* val) const;
+  virtual bool Read(const wxString& key, bool* val, bool defVal) const;
 
     // write the value (return true on success)
-  virtual bool Write(const char *szKey, const char *szValue) = 0;
-  virtual bool Write(const char *szKey, long lValue) = 0;
+  virtual bool Write(const wxString& key, const wxString& value) = 0;
+  virtual bool Write(const wxString& key, long value) = 0;
+
+  // Convenience functions
+  virtual bool Write(const wxString& key, double value);
+  virtual bool Write(const wxString& key, bool value);
+
     // permanently writes all changes
   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
 
   // delete entries/groups
     // deletes the specified entry and the group it belongs to if
     // it was the last key in it and the second parameter is true
-  virtual bool DeleteEntry(const char *szKey,
+  virtual bool DeleteEntry(const wxString& key,
                            bool bDeleteGroupIfEmpty = TRUE) = 0;
     // delete the group (with all subgroups)
-  virtual bool DeleteGroup(const char *szKey) = 0;
+  virtual bool DeleteGroup(const wxString& key) = 0;
     // delete the whole underlying object (disk file, registry key, ...)
     // primarly for use by desinstallation routine.
   virtual bool DeleteAll() = 0;
@@ -186,20 +213,49 @@ public:
         return tmp;
     }
 
+    // misc accessors
+  inline wxString GetAppName() const { return m_appName; }
+  inline wxString GetVendorName() const { return m_vendorName; }
+
+  inline void SetAppName(const wxString& appName) { m_appName = appName; }
+  inline void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
+
+  inline void SetStyle(long style) { m_style = style; }
+  inline long GetStyle() const { return m_style; }
+
 protected:
-  static bool IsImmutable(const char *szKey)
-    { return *szKey == wxCONFIG_IMMUTABLE_PREFIX; }
+  static bool IsImmutable(const wxString& key)
+    { return key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
+
+private:
+  // are we doing automatic environment variable expansion?
+  bool m_bExpandEnvVars;
+  // do we record default values?
+  bool m_bRecordDefaults;
+  
+  // static variables
+  static wxConfigBase *ms_pConfig;
+  static bool          ms_bAutoCreate;
+
+  // Application name and organisation name
+  wxString          m_appName;
+  wxString          m_vendorName;
+
+  // Style flag
+  long              m_style;
+};
 
   // a handy little class which changes current path to the path of given entry
   // and restores it in dtor: so if you declare a local variable of this type,
   // you work in the entry directory and the path is automatically restored
   // when the function returns
-  class PathChanger
+  // Taken out of wxConfig since not all compilers can cope with nested classes.
+  class wxConfigPathChanger
   {
   public:
     // ctor/dtor do path changing/restorin
-    PathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
-   ~PathChanger();
+    wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry);
+   ~wxConfigPathChanger();
 
     // get the key name
     const wxString& Name() const { return m_strName; }
@@ -211,16 +267,6 @@ protected:
     bool          m_bChanged;     // was the path changed?
   };
 
-private:
-  // are we doing automatic environment variable expansion?
-  bool m_bExpandEnvVars;
-  // do we record default values?
-  bool m_bRecordDefaults;
-  
-  // static variables
-  static wxConfigBase *ms_pConfig;
-  static bool          ms_bAutoCreate;
-};
 
 // ----------------------------------------------------------------------------
 // the native wxConfigBase implementation
@@ -230,15 +276,17 @@ private:
 #if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
   #ifdef __WIN32__
     #define wxConfig  wxRegConfig
-    #define classwxConfig classwxRegConfig
+    #define sm_classwxConfig sm_classwxRegConfig
   #else  //WIN16
     #define wxConfig  wxIniConfig
-    #define classwxConfig classwxIniConfig
+    #define sm_classwxConfig sm_classwxIniConfig
   #endif
 #else // either we're under Unix or wish to use files even under Windows
   #define wxConfig  wxFileConfig
-  #define classwxConfig classwxFileConfig
+  #define sm_classwxConfig sm_classwxFileConfig
 #endif
 
+
+
 #endif  // _WX_CONFIG_H_