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
This commit is contained in:
Manolo Gouy 2018-11-27 12:41:39 +00:00
parent 4881b982a3
commit 46f08f6d21

View File

@ -51,6 +51,15 @@
reasons. One application can have multiple preferences files. reasons. One application can have multiple preferences files.
Extensive binary data however should be stored in separate Extensive binary data however should be stored in separate
files: see getUserdataPath(). 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 \note Starting with FLTK 1.3, preference databases are expected to
be in UTF-8 encoding. Previous databases were stored in the be in UTF-8 encoding. Previous databases were stored in the