]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/confbase.h
doc view code inteprets wxSTREAM_EOF as correct,
[wxWidgets.git] / include / wx / confbase.h
index 2c31f070ef730401ebf317dace5658a9f93810c9..abb5f96dd0e049718940d718fc2e05df291aba07 100644 (file)
   #define   wxCONFIG_IMMUTABLE_PREFIX   '!'
 #endif
 
-/// should we use registry instead of configuration files under Win32?
+/// should we use registry instead of configuration files under Windows?
 // (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's
 //  FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig
 //  (under Win16))
-#ifndef   wxCONFIG_WIN32_NATIVE
-  #define wxCONFIG_WIN32_NATIVE          TRUE
+#ifndef   wxUSE_CONFIG_NATIVE
+  #define wxUSE_CONFIG_NATIVE 1
 #endif
 
 // Style flags for constructor style parameter
-#define wxCONFIG_USE_LOCAL_FILE         1
-#define wxCONFIG_USE_GLOBAL_FILE        2
-
-// ----------------------------------------------------------------------------
-// various helper global functions
-// ----------------------------------------------------------------------------
-
-/*
-  Replace environment variables ($SOMETHING) with their values. The format is
-  $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
-  '_' only. '$' must be escaped ('\$') in order to be taken literally.
- */
-extern wxString wxExpandEnvVars(const wxString &sz);
-
-/*
-  Split path into parts removing '..' in progress
- */
-extern void wxSplitPath(wxArrayString& aParts, const char *sz);
+enum
+{
+    wxCONFIG_USE_LOCAL_FILE = 1,
+    wxCONFIG_USE_GLOBAL_FILE = 2,
+    wxCONFIG_USE_RELATIVE_PATH = 4
+};
 
 // ----------------------------------------------------------------------------
 // abstract base class wxConfigBase which defines the interface for derived
@@ -81,7 +69,7 @@ extern void wxSplitPath(wxArrayString& aParts, const char *sz);
 // There is always one current group given by the current path.
 //
 // Keys are pairs "key_name = value" where value may be of string or integer
-// (long) type (@@@ doubles and other types such as wxDate coming soon).
+// (long) type (TODO doubles and other types such as wxDate coming soon).
 // ----------------------------------------------------------------------------
 class WXDLLEXPORT wxConfigBase
 {
@@ -90,11 +78,11 @@ public:
     // the type of an entry
   enum EntryType
   {
-    Unknown,
-    String,
-    Boolean,
-    Integer,    // use Read(long *)
-    Float       // use Read(double *)
+    Type_Unknown,
+    Type_String,
+    Type_Boolean,
+    Type_Integer,    // use Read(long *)
+    Type_Float       // use Read(double *)
   };
 
   // static functions
@@ -105,23 +93,22 @@ public:
   static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
     // create a new config object: this function will create the "best"
     // implementation of wxConfig available for the current platform, see
-    // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns
+    // comments near definition wxUSE_CONFIG_NATIVE for details. It returns
     // the created object and also sets it as ms_pConfig.
   static wxConfigBase *Create();
     // should Get() try to create a new log object if the current one is NULL?
   static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
 
   // ctor & virtual dtor
-    // environment variable expansion is on by default
-//  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 = wxEmptyString, const wxString& vendorName = wxEmptyString,
-               const wxString& localFilename = wxEmptyString, const wxString& globalFilename = wxEmptyString,
+      // ctor (can be used as default ctor too)
+      //
+      // 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 = wxEmptyString,
+               const wxString& vendorName = wxEmptyString,
+               const wxString& localFilename = wxEmptyString,
+               const wxString& globalFilename = wxEmptyString,
                long style = 0);
 
     // empty but ensures that dtor of all derived classes is virtual
@@ -161,7 +148,7 @@ public:
   virtual EntryType GetEntryType(const wxString& name) const
   {
     // by default all entries are strings
-    return HasEntry(name) ? String : Unknown;
+    return HasEntry(name) ? Type_String : Type_Unknown;
   }
 
   // key access: returns TRUE if value was really read, FALSE if default used
@@ -199,6 +186,7 @@ public:
   // Convenience functions
   virtual bool Write(const wxString& key, double value);
   virtual bool Write(const wxString& key, bool value);
+  virtual bool Write(const wxString& key, const wxChar *text ) ;
 
     // permanently writes all changes
   virtual bool Flush(bool bCurrentOnly = FALSE) = 0;
@@ -238,19 +226,12 @@ public:
   wxString GetAppName() const { return m_appName; }
   wxString GetVendorName() const { return m_vendorName; }
 
-  void SetAppName(const wxString& appName) { m_appName = appName; }
-  void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
-
   void SetStyle(long style) { m_style = style; }
   long GetStyle() const { return m_style; }
 
 protected:
   static bool IsImmutable(const wxString& key)
-  #ifndef __WXMAC__
-    { return !key.IsEmpty() && key[0u] == wxCONFIG_IMMUTABLE_PREFIX; }
-  #else
-    { return !key.IsEmpty() && key[0ul] == wxCONFIG_IMMUTABLE_PREFIX; }
-  #endif
+    { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; }
 
 private:
   // are we doing automatic environment variable expansion?
@@ -298,7 +279,7 @@ private:
 // ----------------------------------------------------------------------------
 
 // under Windows we prefer to use the native implementation
-#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE
+#if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
   #ifdef __WIN32__
     #define wxConfig  wxRegConfig
     #define sm_classwxConfig sm_classwxRegConfig
@@ -311,9 +292,23 @@ private:
   #define sm_classwxConfig sm_classwxFileConfig
 #endif
 
-#endif
+#endif // wxUSE_CONFIG
 
-  // wxUSE_CONFIG
+// ----------------------------------------------------------------------------
+// various helper global functions (defined even if !wxUSE_CONFIG)
+// ----------------------------------------------------------------------------
+
+/*
+  Replace environment variables ($SOMETHING) with their values. The format is
+  $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and
+  '_' only. '$' must be escaped ('\$') in order to be taken literally.
+ */
+extern wxString wxExpandEnvVars(const wxString &sz);
+
+/*
+  Split path into parts removing '..' in progress
+ */
+extern void wxSplitPath(wxArrayString& aParts, const wxChar *sz);
 
 #endif
   // _WX_CONFIG_H_