]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/config.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
test that iterator is valid before comparing with it (another bug introduced when...
[wxWidgets.git] / interface / config.h
diff --git a/interface/config.h b/interface/config.h
index 0f9bf1a69df55b49c51db0c6c8347900f233e683..c0dae59d6487e3dff9fe6e94e174b9dea48c56e1 100644 (file)
--- a/interface/config.h
+++ b/interface/config.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        config.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        config.h
-// Purpose:     documentation for wxConfigBase class
+// Purpose:     interface of wxConfigBase
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -41,7 +41,7 @@ public:
         )
         This is the default and only constructor of the wxConfigBase class, and
         derived classes.
         )
         This is the default and only constructor of the wxConfigBase class, and
         derived classes.
-        
+
         @param appName
             The application name. If this is empty, the class will
             normally use wxApp::GetAppName to set it. The
         @param appName
             The application name. If this is empty, the class will
             normally use wxApp::GetAppName to set it. The
@@ -83,7 +83,8 @@ public:
             flag, which changes the default local configuration file to
         ~/.appname/appname
             should be used. Notice that this flag is ignored if localFilename is
             flag, which changes the default local configuration file to
         ~/.appname/appname
             should be used. Notice that this flag is ignored if localFilename is
-            provided. This function is new since wxWidgets version 2.8.2
+            provided.
+        @wxsince{2.8.2}
             For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which
             will turn off character escaping for the values of entries stored in the
         config
             For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which
             will turn off character escaping for the values of entries stored in the
         config
@@ -100,7 +101,7 @@ public:
             This parameter is only used by wxFileConfig when compiled
             in Unicode mode. It specifies the encoding in which the configuration file
             is written.
             This parameter is only used by wxFileConfig when compiled
             in Unicode mode. It specifies the encoding in which the configuration file
             is written.
-        
+
         @remarks By default, environment variable expansion is on and recording
                  defaults is off.
     */
         @remarks By default, environment variable expansion is on and recording
                  defaults is off.
     */
@@ -117,7 +118,7 @@ public:
 
     /**
         @ref ctor() wxConfigBase
 
     /**
         @ref ctor() wxConfigBase
-        
+
         @ref dtor() ~wxConfigBase
     */
 
         @ref dtor() ~wxConfigBase
     */
 
@@ -135,9 +136,9 @@ public:
         config file. @e DeleteAll() is especially useful if you want to erase all
         traces of your program presence: for example, when you uninstall it.
         DeleteEntry()
         config file. @e DeleteAll() is especially useful if you want to erase all
         traces of your program presence: for example, when you uninstall it.
         DeleteEntry()
-        
+
         DeleteGroup()
         DeleteGroup()
-        
+
         DeleteAll()
     */
 
         DeleteAll()
     */
 
@@ -181,19 +182,19 @@ public:
         from running several enumerations simultaneously, that's why you must pass it
         explicitly.
         Having said all this, enumerating the config entries/groups is very simple:
         from running several enumerations simultaneously, that's why you must pass it
         explicitly.
         Having said all this, enumerating the config entries/groups is very simple:
-        
+
         There are also functions to get the number of entries/subgroups without
         actually enumerating them, but you will probably never need them.
         GetFirstGroup()
         There are also functions to get the number of entries/subgroups without
         actually enumerating them, but you will probably never need them.
         GetFirstGroup()
-        
+
         GetNextGroup()
         GetNextGroup()
-        
+
         GetFirstEntry()
         GetFirstEntry()
-        
+
         GetNextEntry()
         GetNextEntry()
-        
+
         GetNumberOfEntries()
         GetNumberOfEntries()
-        
+
         GetNumberOfGroups()
     */
 
         GetNumberOfGroups()
     */
 
@@ -201,7 +202,7 @@ public:
     /**
         returns @true if either a group or an entry with a given name exists
     */
     /**
         returns @true if either a group or an entry with a given name exists
     */
-    bool Exists(wxString& strName);
+    bool Exists(wxString& strName) const;
 
     /**
         permanently writes all changes (otherwise, they're only written from object's
 
     /**
         permanently writes all changes (otherwise, they're only written from object's
@@ -219,7 +220,7 @@ public:
     /**
         Returns the application name.
     */
     /**
         Returns the application name.
     */
-    wxString GetAppName();
+    wxString GetAppName() const;
 
     /**
         Returns the type of the given entry or @e Unknown if the entry doesn't
 
     /**
         Returns the type of the given entry or @e Unknown if the entry doesn't
@@ -229,68 +230,68 @@ public:
         key with wxRegConfig will fail.
         The result is an element of enum EntryType:
     */
         key with wxRegConfig will fail.
         The result is an element of enum EntryType:
     */
-    enum wxConfigBase::EntryType GetEntryType(const wxString& name);
+    enum wxConfigBase::EntryType GetEntryType(const wxString& name) const;
 
     /**
         Gets the first entry.
     */
 
     /**
         Gets the first entry.
     */
-    bool GetFirstEntry(wxString& str, long& index);
+    bool GetFirstEntry(wxString& str, long& index) const;
 
     /**
         Gets the first group.
     */
 
     /**
         Gets the first group.
     */
-    bool GetFirstGroup(wxString& str, long& index);
+    bool GetFirstGroup(wxString& str, long& index) const;
 
     /**
         Gets the next entry.
     */
 
     /**
         Gets the next entry.
     */
-    bool GetNextEntry(wxString& str, long& index);
+    bool GetNextEntry(wxString& str, long& index) const;
 
     /**
         Gets the next group.
     */
 
     /**
         Gets the next group.
     */
-    bool GetNextGroup(wxString& str, long& index);
+    bool GetNextGroup(wxString& str, long& index) const;
 
     /**
 
     /**
-        
+
     */
     */
-    uint GetNumberOfEntries(bool bRecursive = false);
+    uint GetNumberOfEntries(bool bRecursive = false) const;
 
     /**
         Get number of entries/subgroups in the current group, with or without its
         subgroups.
     */
 
     /**
         Get number of entries/subgroups in the current group, with or without its
         subgroups.
     */
-    uint GetNumberOfGroups(bool bRecursive = false);
+    uint GetNumberOfGroups(bool bRecursive = false) const;
 
     /**
         Retrieve the current path (always as absolute path).
     */
 
     /**
         Retrieve the current path (always as absolute path).
     */
-    const wxString GetPath();
+    const wxString GetPath() const;
 
     /**
         Returns the vendor name.
     */
 
     /**
         Returns the vendor name.
     */
-    wxString GetVendorName();
+    wxString GetVendorName() const;
 
     /**
         returns @true if the entry by this name exists
     */
 
     /**
         returns @true if the entry by this name exists
     */
-    bool HasEntry(wxString& strName);
+    bool HasEntry(wxString& strName) const;
 
     /**
         returns @true if the group by this name exists
     */
 
     /**
         returns @true if the group by this name exists
     */
-    bool HasGroup(const wxString& strName);
+    bool HasGroup(const wxString& strName) const;
 
     /**
         Returns @true if we are expanding environment variables in key values.
     */
 
     /**
         Returns @true if we are expanding environment variables in key values.
     */
-    bool IsExpandingEnvVars();
+    bool IsExpandingEnvVars() const;
 
     /**
         Returns @true if we are writing defaults back to the config file.
     */
 
     /**
         Returns @true if we are writing defaults back to the config file.
     */
-    bool IsRecordingDefaults();
+    bool IsRecordingDefaults() const;
 
     /**
         These function are the core of wxConfigBase class: they allow you to read and
 
     /**
         These function are the core of wxConfigBase class: they allow you to read and
@@ -299,8 +300,8 @@ public:
         Currently, supported types of data are:
         wxString, @e long, @e double, @e bool,
         wxColour and any other types,
         Currently, supported types of data are:
         wxString, @e long, @e double, @e bool,
         wxColour and any other types,
-        for which functions wxToString
-        and wxFromString are defined.
+        for which functions wxToString()
+        and wxFromString() are defined.
         Try not to read long values into string variables and vice versa: although it
         just might work with wxFileConfig, you will get a system error with
         wxRegConfig because in the Windows registry the different types of entries are
         Try not to read long values into string variables and vice versa: although it
         just might work with wxFileConfig, you will get a system error with
         wxRegConfig because in the Windows registry the different types of entries are
@@ -308,18 +309,18 @@ public:
         Final remark: the @e szKey parameter for all these functions can contain an
         arbitrary path (either relative or absolute), not just the key name.
         Read()
         Final remark: the @e szKey parameter for all these functions can contain an
         arbitrary path (either relative or absolute), not just the key name.
         Read()
-        
+
         Write()
         Write()
-        
+
         Flush()
     */
 
 
     /**
         GetAppName()
         Flush()
     */
 
 
     /**
         GetAppName()
-        
+
         GetVendorName()
         GetVendorName()
-        
+
         wxFileConfig::SetUmask
     */
 
         wxFileConfig::SetUmask
     */
 
@@ -329,7 +330,7 @@ public:
         first of them is the expansion of environment variables in the string values
         read from the config file: for example, if you have the following in your
         config file:
         first of them is the expansion of environment variables in the string values
         read from the config file: for example, if you have the following in your
         config file:
-        
+
         the call to @c config-Read("UserData") will return something like
         @c "/home/zeitlin/data" if you're lucky enough to run a Linux system ;-)
         Although this feature is very useful, it may be annoying if you read a value
         the call to @c config-Read("UserData") will return something like
         @c "/home/zeitlin/data" if you're lucky enough to run a Linux system ;-)
         Although this feature is very useful, it may be annoying if you read a value
@@ -340,11 +341,11 @@ public:
         would be to prefix the offending symbols with a backslash.
         The following functions control this option:
         IsExpandingEnvVars()
         would be to prefix the offending symbols with a backslash.
         The following functions control this option:
         IsExpandingEnvVars()
-        
+
         SetExpandEnvVars()
         SetExpandEnvVars()
-        
+
         SetRecordDefaults()
         SetRecordDefaults()
-        
+
         IsRecordingDefaults()
     */
 
         IsRecordingDefaults()
     */
 
@@ -358,18 +359,18 @@ public:
         which makes it possible to use the relative paths. To clarify all this, here
         is an example (it is only for the sake of demonstration, it doesn't do anything
         sensible!):
         which makes it possible to use the relative paths. To clarify all this, here
         is an example (it is only for the sake of demonstration, it doesn't do anything
         sensible!):
-        
+
         @e Warning: it is probably a good idea to always restore the path to its
         old value on function exit:
         @e Warning: it is probably a good idea to always restore the path to its
         old value on function exit:
-        
+
         because otherwise the assert in the following example will surely fail
         (we suppose here that @e foo() function is the same as above except that it
         doesn't save and restore the path):
         because otherwise the assert in the following example will surely fail
         (we suppose here that @e foo() function is the same as above except that it
         doesn't save and restore the path):
-        
+
         Finally, the path separator in wxConfigBase and derived classes is always '/',
         regardless of the platform (i.e. it is @b not '\\' under Windows).
         SetPath()
         Finally, the path separator in wxConfigBase and derived classes is always '/',
         regardless of the platform (i.e. it is @b not '\\' under Windows).
         SetPath()
-        
+
         GetPath()
     */
 
         GetPath()
     */
 
@@ -377,70 +378,73 @@ public:
     //@{
     /**
         Reads a value of type T, for which function
     //@{
     /**
         Reads a value of type T, for which function
-        wxFromString is defined,
+        wxFromString() is defined,
         returning @true if the value was found.
         If the value was not found, @a defaultVal is used instead.
         bool Read(const wxStringkey, T* value) const;
         returning @true if the value was found.
         If the value was not found, @a defaultVal is used instead.
         bool Read(const wxStringkey, T* value) const;
-        
-        
+
+
         @b Read(key, default="")
         @b Read(key, default="")
-        
+
         Returns a string
         Returns a string
-        
+
         @b ReadInt(key, default=0)
         @b ReadInt(key, default=0)
-        
+
         Returns an integer
         Returns an integer
-        
+
         @b ReadFloat(key, default=0.0)
         @b ReadFloat(key, default=0.0)
-        
+
         Returns a floating point number
         Returns a floating point number
-        
+
         @b ReadBool(key, default=0)
         @b ReadBool(key, default=0)
-        
+
         Returns a boolean
     */
         Returns a boolean
     */
-    bool Read(const wxString& key, wxString* str);
-    bool Read(const wxString& key, wxString* str,
-              const wxString& defaultVal);
-    wxString Read(const wxString& key,
-                  const
-                  wxString& defaultVal);
-    bool Read(const wxString& key, long* l);
-    bool Read(const wxString& key, long* l, long defaultVal);
-    bool Read(const wxString& key, double* d);
-    bool Read(const wxString& key, double* d, double defaultVal);
-    bool Read(const wxString& key, bool* b);
-    bool Read(const wxString& key, bool* d, bool defaultVal);
-    bool Read(const wxString& key, wxMemoryBuffer* buf);
-    bool Read(const wxString& key, T* value);
-    bool Read(const wxString& key, T* value,
-              T const& defaultVal);
+    bool Read(const wxString& key, wxString* str) const;
+    const bool Read(const wxString& key, wxString* str,
+                    const wxString& defaultVal) const;
+    const wxString  Read(const wxString& key,
+                         const
+                         wxString& defaultVal) const;
+    const bool Read(const wxString& key, long* l) const;
+    const bool Read(const wxString& key, long* l,
+                    long defaultVal) const;
+    const bool Read(const wxString& key, double* d) const;
+    const bool Read(const wxString& key, double* d,
+                    double defaultVal) const;
+    const bool Read(const wxString& key, bool* b) const;
+    const bool Read(const wxString& key, bool* d,
+                    bool defaultVal) const;
+    const bool Read(const wxString& key, wxMemoryBuffer* buf) const;
+    const bool Read(const wxString& key, T* value) const;
+    const bool Read(const wxString& key, T* value,
+                    T const& defaultVal) const;
     //@}
 
     /**
         Reads a bool value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
     //@}
 
     /**
         Reads a bool value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
-    long ReadBool(const wxString& key, bool defaultVal);
+    long ReadBool(const wxString& key, bool defaultVal) const;
 
     /**
         Reads a double value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
 
     /**
         Reads a double value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
-    long ReadDouble(const wxString& key, double defaultVal);
+    long ReadDouble(const wxString& key, double defaultVal) const;
 
     /**
         Reads a long value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
 
     /**
         Reads a long value from the key and returns it. @a defaultVal is returned
         if the key is not found.
     */
-    long ReadLong(const wxString& key, long defaultVal);
+    long ReadLong(const wxString& key, long defaultVal) const;
 
     /**
         Reads a value of type T, for which function
 
     /**
         Reads a value of type T, for which function
-        wxFromString is defined, from the key and returns it.
+        wxFromString() is defined, from the key and returns it.
         @a defaultVal is returned if the key is not found.
     */
         @a defaultVal is returned if the key is not found.
     */
-    T ReadObject(const wxString& key, T const& defaultVal);
+    T ReadObject(const wxString& key, T const& defaultVal) const;
 
     /**
         The functions in this section allow to rename entries or subgroups of the
 
     /**
         The functions in this section allow to rename entries or subgroups of the
@@ -449,7 +453,7 @@ public:
         the new name already exists or because the function is not supported in this
         wxConfig implementation.
         RenameEntry()
         the new name already exists or because the function is not supported in this
         wxConfig implementation.
         RenameEntry()
-        
+
         RenameGroup()
     */
 
         RenameGroup()
     */
 
@@ -517,27 +521,27 @@ public:
         you may forget about calling @e Set(). When @e Get() is called and there
         is no current object, it will create one using @e Create() function. To
         disable this behaviour @e DontCreateOnDemand() is provided.
         you may forget about calling @e Set(). When @e Get() is called and there
         is no current object, it will create one using @e Create() function. To
         disable this behaviour @e DontCreateOnDemand() is provided.
-        @b Note: You should use either @e Set() or @e Get() because wxWidgets
+        @note You should use either @e Set() or @e Get() because wxWidgets
         library itself would take advantage of it and could save various information
         in it. For example wxFontMapper or Unix version
         of wxFileDialog have the ability to use wxConfig class.
         Set()
         library itself would take advantage of it and could save various information
         in it. For example wxFontMapper or Unix version
         of wxFileDialog have the ability to use wxConfig class.
         Set()
-        
+
         Get()
         Get()
-        
+
         Create()
         Create()
-        
+
         DontCreateOnDemand()
     */
 
 
     /**
         HasGroup()
         DontCreateOnDemand()
     */
 
 
     /**
         HasGroup()
-        
+
         HasEntry()
         HasEntry()
-        
+
         Exists()
         Exists()
-        
+
         GetEntryType()
     */
 
         GetEntryType()
     */
 
@@ -545,24 +549,24 @@ public:
     //@{
     /**
         These functions write the specified value to the config file and return @true
     //@{
     /**
         These functions write the specified value to the config file and return @true
-        on success. In the last one, function wxToString must be
+        on success. In the last one, function wxToString() must be
         defined for type @e T.
         defined for type @e T.
-        
-        
+
+
         @b Write(key, value)
         @b Write(key, value)
-        
+
         Writes a string
         Writes a string
-        
+
         @b WriteInt(key, value)
         @b WriteInt(key, value)
-        
+
         Writes an integer
         Writes an integer
-        
+
         @b WriteFloat(key, value)
         @b WriteFloat(key, value)
-        
+
         Writes a floating point number
         Writes a floating point number
-        
+
         @b WriteBool(key, value)
         @b WriteBool(key, value)
-        
+
         Writes a boolean
     */
     bool Write(const wxString& key, const wxString& value);
         Writes a boolean
     */
     bool Write(const wxString& key, const wxString& value);
@@ -573,3 +577,4 @@ public:
     bool Write(const wxString& key, const T& buf);
     //@}
 };
     bool Write(const wxString& key, const T& buf);
     //@}
 };
+
wxWidgets (Impactor)