diff options
| author | Matthias Melcher <git@matthiasm.com> | 2020-01-14 19:21:58 +0100 |
|---|---|---|
| committer | Matthias Melcher <git@matthiasm.com> | 2020-01-14 19:21:58 +0100 |
| commit | ed80d9cef0c321012c65c31104be66dc64bf2fad (patch) | |
| tree | 3e1121bbc85efe374bc9fd1c5dd4de6e975ed9db /FL/Fl_Preferences.H | |
| parent | 006d71c663112316c49ff50f395f7d0aef8ebfe8 (diff) | |
Fixed some documentation for Fl_Preferences and fl_make_path.
Diffstat (limited to 'FL/Fl_Preferences.H')
| -rw-r--r-- | FL/Fl_Preferences.H | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H index 45717265a..eff8e1aae 100644 --- a/FL/Fl_Preferences.H +++ b/FL/Fl_Preferences.H @@ -50,21 +50,16 @@ preferences file should be kept small for performance reasons. One application can have multiple preferences files. Extensive binary data however should be stored in separate - files: see getUserdataPath(). + files: see \a Fl_Preferences::getUserdataPath() . - \note Platform-specific location of the Fl_Preferences text files. - This construct - \code new Fl_Preferences(Fl_Preferences::USER, "vendor", "application"); \endcode - where "vendor" and "application" are any user-chosen strings, will create these text files: - \li Windows XP platform: <tt>C:\\Documents and Settings\\<i>username</i>\\Application Data\\<i>vendor</i>\\<i>application</i>.prefs</tt> - \li Windows 7+ platform: <tt>C:\\Users\\<i>username</i>\\AppData\\Roaming\\<i>vendor</i>\\<i>application</i>.prefs </tt> - \li X11 platform: <tt>$HOME/.fltk/<i>vendor</i>/<i>application</i>.prefs </tt> - \li MacOS platform: <tt>$HOME/Library/Preferences/<i>vendor</i>/<i>application</i>.prefs </tt> - \note Starting with FLTK 1.3, preference databases are expected to be in UTF-8 encoding. Previous databases were stored in the current character set or code page which renders them incompatible for text entries using international characters. + + \note Starting with FLTK 1.4, searching a valid path to store the preferences + files has changed slightly. Please see <i>Fl_Preferences::Fl_Preferences(Root, const char*, const char*)</i> + for details. */ class FL_EXPORT Fl_Preferences { |