X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e9321277925fc8eb439dd713fc7015cc873f0c38..1b7751aaa9a86d76a850b9267bc0c201e3cea30f:/interface/wx/fileconf.h?ds=sidebyside diff --git a/interface/wx/fileconf.h b/interface/wx/fileconf.h index 5f22d8a79d..14ea2df11f 100644 --- a/interface/wx/fileconf.h +++ b/interface/wx/fileconf.h @@ -27,9 +27,21 @@ class wxFileConfig : public wxConfigBase { public: - - // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE or - // wxCONFIG_USE_GLOBAL_FILE to say which files should be used. + /** + Constructor allowing to choose the file names to use. + + If @a localFilename and/or @a globalFilename are explicitly specified, + they are used as the names of the user and system-wide configuration + files (the latter is only read by the program while the former is read + from and written to). Otherwise the behaviour depends on @a style + parameter. If it includes ::wxCONFIG_USE_LOCAL_FILE, then the local + file name is constructed from the information in @a appName and @a + vendorName arguments in a system-dependent way. If + ::wxCONFIG_USE_GLOBAL_FILE is not specified at all (and @a + globalFilename is empty) then the system-wide file is not used at all. + Otherwise its name and path are also constructed in the way appropriate + for the current platform from the application and vendor names. + */ wxFileConfig(const wxString& appName = wxEmptyString, const wxString& vendorName = wxEmptyString, const wxString& localFilename = wxEmptyString,