diff --git a/FL/Fl_Preferences.H b/FL/Fl_Preferences.H index db0708967..af2c8fd87 100644 --- a/FL/Fl_Preferences.H +++ b/FL/Fl_Preferences.H @@ -51,6 +51,15 @@ reasons. One application can have multiple preferences files. Extensive binary data however should be stored in separate files: see 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: C:\\Documents and Settings\\username\\Application Data\\vendor\\application.prefs + \li Windows 7+ platform: C:\\Users\\username\\AppData\\Roaming\\vendor\\application.prefs + \li X11 platform: $HOME/.fltk/vendor/application.prefs + \li MacOS platform: $HOME/Library/Preferences/vendor/application.prefs \note Starting with FLTK 1.3, preference databases are expected to be in UTF-8 encoding. Previous databases were stored in the