diff options
| author | Manolo Gouy <Manolo> | 2018-11-27 12:41:39 +0000 |
|---|---|---|
| committer | Manolo Gouy <Manolo> | 2018-11-27 12:41:39 +0000 |
| commit | 46f08f6d21aa55f8c6539d2a0191622ef6464c5f (patch) | |
| tree | 3f5f27788c847374ddd018e4ca654337c5c93892 /FL | |
| parent | 4881b982a3562a1f6f0008182ad95e8dbc3655e6 (diff) | |
Documentation: reveal where the Fl_Preferences text files are located on each platform.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13136 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
| -rw-r--r-- | FL/Fl_Preferences.H | 9 |
1 files changed, 9 insertions, 0 deletions
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: <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 |