Author: manolo
Date: 2012-10-19 02:38:24 -0700 (Fri, 19 Oct 2012)
New Revision: 9703
Log:
Documented the fltk3::fopen() utility function.

Modified:
   branches/branch-3.0/documentation/src/osissues.dox
   branches/branch-3.0/include/fltk3/NativeFileChooser.h
   branches/branch-3.0/src/fltk3/FileChooser2.cxx
   branches/branch-3.0/src/fltk3/utf8.cxx

Modified: branches/branch-3.0/documentation/src/osissues.dox
===================================================================
--- branches/branch-3.0/documentation/src/osissues.dox  2012-10-19 09:23:05 UTC 
(rev 9702)
+++ branches/branch-3.0/documentation/src/osissues.dox  2012-10-19 09:38:24 UTC 
(rev 9703)
@@ -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
+fltk3::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-3.0/include/fltk3/NativeFileChooser.h
===================================================================
--- branches/branch-3.0/include/fltk3/NativeFileChooser.h       2012-10-19 
09:23:05 UTC (rev 9702)
+++ branches/branch-3.0/include/fltk3/NativeFileChooser.h       2012-10-19 
09:38:24 UTC (rev 9703)
@@ -93,6 +93,11 @@
    }
    \endcode
    
+   The fltk3::NativeFileChooser widget transmits UTF-8 encoded filenames to 
its user. It is
+   recommended to open files that may have non-ASCII names with the 
fltk3::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 
fltk3::FileIcon::load_system_icons()

Modified: branches/branch-3.0/src/fltk3/FileChooser2.cxx
===================================================================
--- branches/branch-3.0/src/fltk3/FileChooser2.cxx      2012-10-19 09:23:05 UTC 
(rev 9702)
+++ branches/branch-3.0/src/fltk3/FileChooser2.cxx      2012-10-19 09:38:24 UTC 
(rev 9703)
@@ -35,7 +35,12 @@
   
   \image html fltk3::FileChooser.jpg 
   \image latex  fltk3::FileChooser.jpg "fltk3::FileChooser" width=12cm
-  
+
+ The fltk3::FileChooser widget transmits UTF-8 encoded filenames to its user. 
It is
+ recommended to open files that may have non-ASCII names with the 
fltk3::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 fltk3::FileChooser class also exports several static values
   that may be used to localize or customize the appearance of all file chooser
   dialogs:

Modified: branches/branch-3.0/src/fltk3/utf8.cxx
===================================================================
--- branches/branch-3.0/src/fltk3/utf8.cxx      2012-10-19 09:23:05 UTC (rev 
9702)
+++ branches/branch-3.0/src/fltk3/utf8.cxx      2012-10-19 09:38:24 UTC (rev 
9703)
@@ -597,6 +597,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 *fltk3::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