Author: manolo Date: 2012-10-19 04:23:51 -0700 (Fri, 19 Oct 2012) New Revision: 9704 Log: Documented the fl_open() utility function.
Modified: branches/branch-1.3/FL/Fl_Native_File_Chooser.H branches/branch-1.3/FL/filename.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-19 09:38:24 UTC (rev 9703) +++ branches/branch-1.3/FL/Fl_Native_File_Chooser.H 2012-10-19 11:23:51 UTC (rev 9704) @@ -84,9 +84,10 @@ \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). + recommended to open files that may have non-ASCII names with the fl_fopen() or + fl_open() utility functions that handle these names in a cross-platform way + (whereas the standard fopen()/open() functions fail on the MSWindows platform + to open files with a non-ASCII name). <B>Platform Specific Caveats</B> Modified: branches/branch-1.3/FL/filename.H =================================================================== --- branches/branch-1.3/FL/filename.H 2012-10-19 09:38:24 UTC (rev 9703) +++ branches/branch-1.3/FL/filename.H 2012-10-19 11:23:51 UTC (rev 9704) @@ -15,6 +15,9 @@ * * http://www.fltk.org/str.php */ +/** \file + File names and URI utility functions. + */ /* Xcode on OS X includes files by recursing down into directories. * This code catches the cycle and directly includes the required file. Modified: branches/branch-1.3/documentation/src/osissues.dox =================================================================== --- branches/branch-1.3/documentation/src/osissues.dox 2012-10-19 09:38:24 UTC (rev 9703) +++ branches/branch-1.3/documentation/src/osissues.dox 2012-10-19 11:23:51 UTC (rev 9704) @@ -475,9 +475,9 @@ \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. +In FLTK, all strings, including filenames, are UTF-8 encoded. The utility functions +fl_fopen() and fl_open() allow to open files potentially having non-ASCII names in a +cross-platform fashion, whereas the standard fopen()/open() functions fail to do so. \subsection osissues_win32_messages Handling Other WIN32 Messages Modified: branches/branch-1.3/src/Fl_File_Chooser2.cxx =================================================================== --- branches/branch-1.3/src/Fl_File_Chooser2.cxx 2012-10-19 09:38:24 UTC (rev 9703) +++ branches/branch-1.3/src/Fl_File_Chooser2.cxx 2012-10-19 11:23:51 UTC (rev 9704) @@ -28,10 +28,11 @@ \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). - + recommended to open files that may have non-ASCII names with the fl_fopen() or + fl_open() utility functions that handle these names in a cross-platform way + (whereas the standard fopen()/open() functions fail 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 dialogs: Modified: branches/branch-1.3/src/fl_utf8.cxx =================================================================== --- branches/branch-1.3/src/fl_utf8.cxx 2012-10-19 09:38:24 UTC (rev 9703) +++ branches/branch-1.3/src/fl_utf8.cxx 2012-10-19 11:23:51 UTC (rev 9704) @@ -518,6 +518,15 @@ #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 open() function fails with UTF-8 encoded non-ASCII filenames. + \param f the UTF-8 encoded filename + \param oflags other arguments are as in the standard open() function + \return a file descriptor upon successful completion, or -1 in case of error. + \sa fl_fopen(). + */ int fl_open(const char* f, int oflags, ...) { int pmode; @@ -548,6 +557,7 @@ \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. + \sa fl_open(). */ FILE *fl_fopen(const char* f, const char *mode) { _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
