was incorrectly forcing the font to 12 in most cases, fixes #4745

[wxWidgets.git] / interface / fileconf.h

diff --git a/interface/fileconf.h b/interface/fileconf.h
index cd51b2437635ab5bbc085927104f9abcdfb38f1b..cdef167a0070de34d65c35eb9513f00b75749d44 100644 (file)
--- a/interface/fileconf.h
+++ b/interface/fileconf.h
@@ -13,15 +13,15 @@
     wxFileConfig implements wxConfigBase interface for
     storing and retrieving configuration information using plain text files. The
     files have a simple format reminiscent of Windows INI files with lines of the
     wxFileConfig implements wxConfigBase interface for
     storing and retrieving configuration information using plain text files. The
     files have a simple format reminiscent of Windows INI files with lines of the

-    form @c key = value defining the keys and lines of special form
-    @c [group] indicating the start of each group.
+    form @c "key = value" defining the keys and lines of special form
+    @c "[group]" indicating the start of each group.

 
     This class is used by default for wxConfig on Unix platforms but may also be
     used explicitly if you want to use files and not the registry even under
     Windows.
 
     @library{wxbase}
 
     This class is used by default for wxConfig on Unix platforms but may also be
     used explicitly if you want to use files and not the registry even under
     Windows.
 
     @library{wxbase}

-    @category{FIXME}
+    @category{misc}

 
     @see wxFileConfig::Save
 */
 
     @see wxFileConfig::Save
 */


@@ -29,40 +29,40 @@ class wxFileConfig : public wxConfigBase
 {
 public:
     /**
 {
 public:
     /**

-        )

         Read the config data from the specified stream instead of the associated file,
         as usual.
 
         @see Save()
     */
         Read the config data from the specified stream instead of the associated file,
         as usual.
 
         @see Save()
     */

-    wxFileConfig(wxInputStream& is);
+    wxFileConfig(wxInputStream& is, const wxMBConv& conv = wxConvAuto());

 
     /**
         Return the full path to the file which would be used by wxFileConfig as global,
 
     /**
         Return the full path to the file which would be used by wxFileConfig as global,

-        system-wide, file if it were constructed with @a basename as "global
-        filename'' parameter in the constructor. Notice that this function cannot be
-        used if @a basename is already a full path name.
+        system-wide, file if it were constructed with @a basename as "global filename"
+        parameter in the constructor.
+
+        Notice that this function cannot be used if @a basename is already a full path name.

     */
     static wxFileName GetGlobalFile(const wxString& basename);
 
     /**
         Return the full path to the file which would be used by wxFileConfig as local,
     */
     static wxFileName GetGlobalFile(const wxString& basename);
 
     /**
         Return the full path to the file which would be used by wxFileConfig as local,

-        user-specific, file if it were constructed with @a basename as "local
-        filename'' parameter in the constructor.
-        @a style has the same meaning as in @ref wxConfigBase::ctor constructor
+        user-specific, file if it were constructed with @a basename as "local filename"
+        parameter in the constructor.
+
+        @a style has the same meaning as in @ref wxConfigBase::wxConfigBase "wxConfig constructor"

         and can contain any combination of styles but only wxCONFIG_USE_SUBDIR bit is
         examined by this function.
         and can contain any combination of styles but only wxCONFIG_USE_SUBDIR bit is
         examined by this function.

-        Notice that this function cannot be used if @a basename is already a full
-        path name.
+
+        Notice that this function cannot be used if @a basename is already a full path name.

     */
     */

-    static wxFileName GetLocalFile(const wxString& basename,
-                                   int style = 0);
+    static wxFileName GetLocalFile(const wxString& basename, int style = 0);

 
     /**
 
     /**

-        )

         Saves all config data to the given stream, returns @true if data was saved
         successfully or @false on error.
         Saves all config data to the given stream, returns @true if data was saved
         successfully or @false on error.

-        Note the interaction of this function with the internal "dirty flag'': the
+
+        Note the interaction of this function with the internal "dirty flag": the

         data is saved unconditionally, i.e. even if the object is not dirty. However
         after saving it successfully, the dirty flag is reset so no changes will be
         written back to the file this object is associated with until you change its
         data is saved unconditionally, i.e. even if the object is not dirty. However
         after saving it successfully, the dirty flag is reset so no changes will be
         written back to the file this object is associated with until you change its


@@ -70,13 +70,13 @@ public:
 
         @see wxConfigBase::Flush
     */
 
         @see wxConfigBase::Flush
     */

-    bool Save(wxOutputStream& os);
+    bool Save(wxOutputStream& os, const wxMBConv& conv = wxConvAuto());

 
     /**
         Allows to set the mode to be used for the config file creation. For example, to
         create a config file which is not readable by other users (useful if it stores
 
     /**
         Allows to set the mode to be used for the config file creation. For example, to
         create a config file which is not readable by other users (useful if it stores

-        some sensitive information, such as passwords), you could use
-        @c SetUmask(0077).
+        some sensitive information, such as passwords), you could use @c SetUmask(0077).
+

         This function doesn't do anything on non-Unix platforms.
 
         @see wxCHANGE_UMASK()
         This function doesn't do anything on non-Unix platforms.
 
         @see wxCHANGE_UMASK()