Author: manolo
Date: 2012-10-19 02:23:05 -0700 (Fri, 19 Oct 2012)
New Revision: 9702
Log:
Documented the fl_fopen() utility function.

Modified:
   branches/branch-1.3/FL/Fl_Native_File_Chooser.H
   branches/branch-1.3/documentation/src/osissues.dox
   branches/branch-1.3/src/Fl_File_Chooser2.cxx
   branches/branch-1.3/src/fl_utf8.cxx

Modified: branches/branch-1.3/FL/Fl_Native_File_Chooser.H
===================================================================
--- branches/branch-1.3/FL/Fl_Native_File_Chooser.H     2012-10-18 12:56:31 UTC 
(rev 9701)
+++ branches/branch-1.3/FL/Fl_Native_File_Chooser.H     2012-10-19 09:23:05 UTC 
(rev 9702)
@@ -83,6 +83,11 @@
  }
  \endcode
  
+ The Fl_Native_File_Chooser widget transmits UTF-8 encoded filenames to its 
user. It is
+ recommended to open files that may have non-ASCII names with the fl_fopen() 
utility 
+ function that handles these names in a cross-platform way (whereas the 
standard 
+ fopen() function fails on the MSWindows platform to open files with a 
non-ASCII name).
+ 
  <B>Platform Specific Caveats</B>
  
  - Under X windows, it's best if you call Fl_File_Icon::load_system_icons()

Modified: branches/branch-1.3/documentation/src/osissues.dox
===================================================================
--- branches/branch-1.3/documentation/src/osissues.dox  2012-10-18 12:56:31 UTC 
(rev 9701)
+++ branches/branch-1.3/documentation/src/osissues.dox  2012-10-19 09:23:05 UTC 
(rev 9702)
@@ -473,6 +473,12 @@
 The Windows interface provides access to the WIN32 GDI
 state information and data structures.
 
+\subsection non_ascii_filenames Using filenames with non-ASCII characters
+
+In FLTK, all strings, including filenames, are UTF-8 encoded. The utility 
function
+fl_fopen() allows to open files potentially having non-ASCII names in a 
+cross-platform fashion, whereas the standard fopen() function fails to do so.
+
 \subsection osissues_win32_messages Handling Other WIN32 Messages
 
 By default a single WNDCLASSEX called "FLTK" is

Modified: branches/branch-1.3/src/Fl_File_Chooser2.cxx
===================================================================
--- branches/branch-1.3/src/Fl_File_Chooser2.cxx        2012-10-18 12:56:31 UTC 
(rev 9701)
+++ branches/branch-1.3/src/Fl_File_Chooser2.cxx        2012-10-19 09:23:05 UTC 
(rev 9702)
@@ -26,6 +26,11 @@
   
   \image html Fl_File_Chooser.jpg 
   \image latex  Fl_File_Chooser.jpg "Fl_File_Chooser" width=12cm
+ 
+ The Fl_File_Chooser widget transmits UTF-8 encoded filenames to its user. It 
is
+ recommended to open files that may have non-ASCII names with the fl_fopen() 
utility 
+ function that handles these names in a cross-platform way (whereas the 
standard 
+ fopen() function fails on the MSWindows platform to open files with a 
non-ASCII name).
   
   The Fl_File_Chooser class also exports several static values
   that may be used to localize or customize the appearance of all file chooser

Modified: branches/branch-1.3/src/fl_utf8.cxx
===================================================================
--- branches/branch-1.3/src/fl_utf8.cxx 2012-10-18 12:56:31 UTC (rev 9701)
+++ branches/branch-1.3/src/fl_utf8.cxx 2012-10-19 09:23:05 UTC (rev 9702)
@@ -541,6 +541,14 @@
 #endif
 }
 
+/** Cross-platform function to open files with a UTF-8 encoded name.
+ 
+ This function is especially useful under the MSWindows platform where the 
+ standard fopen() function fails with UTF-8 encoded non-ASCII filenames.
+ \param f  the UTF-8 encoded filename
+ \param mode  same as the second argument of the standard fopen() function
+ \return  a FILE pointer upon successful completion, or NULL in case of error.
+ */
 FILE *fl_fopen(const char* f, const char *mode)
 {
 #if  defined (WIN32) && !defined(__CYGWIN__)

_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit

Reply via email to