Author: greg.ercolano Date: 2011-02-05 09:45:00 -0800 (Sat, 05 Feb 2011) New Revision: 8377 Log: Fixes problem with doxygen docs showing incorrect #include reference at top of docs that was confusing users into #include'ing the wrong file. Problem described here: http://fltk.org/newsgroups.php?gfltk.development+v:11617
Modified: branches/branch-1.3/FL/Fl_Native_File_Chooser.H branches/branch-1.3/FL/Fl_Native_File_Chooser_FLTK.H Modified: branches/branch-1.3/FL/Fl_Native_File_Chooser.H =================================================================== --- branches/branch-1.3/FL/Fl_Native_File_Chooser.H 2011-02-05 17:09:21 UTC (rev 8376) +++ branches/branch-1.3/FL/Fl_Native_File_Chooser.H 2011-02-05 17:45:00 UTC (rev 8377) @@ -26,6 +26,60 @@ // http://www.fltk.org/str.php // +/* \file + Fl_Native_File_Chooser widget. */ + +/** + \class Fl_Native_File_Chooser + + This class lets an FLTK application easily and consistently access + the operating system's native file chooser. Some operating systems + have very complex and specific file choosers that many users want + access to specifically, instead of FLTK's default file chooser(s). + + In cases where there is no native file browser, FLTK's own file browser + is used instead. + + To use this widget correctly, use the following include in your code: + \code + #include <FL/Fl_Native_File_Chooser.H> + \endcode + Do not include the other Fl_Native_File_Choser_XXX.H files in your code; + those are platform specific files that will be included automatically + depending on your build platform. + + The following example shows how to pick a single file: + \code + // Create and post the local native file chooser + #include <FL/Fl_Native_File_Chooser.H> + [..] + Fl_Native_File_Chooser fnfc; + fnfc.title("Pick a file"); + fnfc.type(Fl_Native_File_Chooser::BROWSE_FILE); + fnfc.filter("Text\t*.txt\n" + "C Files\t*.{cxx,h,c}"); + fnfc.directory("/var/tmp"); // default directory to use + // Show native chooser + switch ( fnfc.show() ) { + case -1: printf("ERROR: %s\n", fnfc.errmsg()); break; // ERROR + case 1: printf("CANCEL\n"); break; // CANCEL + default: printf("PICKED: %s\n", fnfc.filename()); break; // FILE CHOSEN + } + \endcode + + <B>Platform Specific Caveats</B> + + - Under X windows, it's best if you call Fl_File_Icon::load_system_icons() + at the start of main(), to enable the nicer looking file browser widgets. + Use the static public attributes of class Fl_File_Chooser to localize + the browser. + - Some operating systems support certain OS specific options; see + Fl_Native_File_Chooser::options() for a list. + + \image html Fl_Native_File_Chooser.png "The Fl_Native_File_Chooser on different platforms." + \image latex Fl_Native_File_Chooser.png "The Fl_Native_File_Chooser on different platforms" width=14cm + +*/ #ifndef FL_NATIVE_FILE_CHOOSER_H #define FL_NATIVE_FILE_CHOOSER_H Modified: branches/branch-1.3/FL/Fl_Native_File_Chooser_FLTK.H =================================================================== --- branches/branch-1.3/FL/Fl_Native_File_Chooser_FLTK.H 2011-02-05 17:09:21 UTC (rev 8376) +++ branches/branch-1.3/FL/Fl_Native_File_Chooser_FLTK.H 2011-02-05 17:45:00 UTC (rev 8377) @@ -26,63 +26,11 @@ // http://www.fltk.org/str.php // -/* \file - Fl_Native_File_Chooser widget. */ - #include <FL/Fl_File_Chooser.H> #ifndef WIN32 #include <unistd.h> // _POSIX_NAME_MAX #endif /*WIN32*/ -/** - This class lets an FLTK application easily and consistently access - the operating system's native file chooser. Some operating systems - have very complex and specific file choosers that many users want - access to specifically, instead of FLTK's default file chooser(s). - - In cases where there is no native file browser, FLTK's own file browser - is used instead. - - To use this widget correctly, use the following include in your code: - \code - #include <FL/Fl_Native_File_Chooser.H> - \endcode - Do not include the other Fl_Native_File_Choser_XXX.H files in your code; - those are platform specific files that will be included automatically - depending on your build platform. - - The following example shows how to pick a single file: - \code - // Create and post the local native file chooser - #include <FL/Fl_Native_File_Chooser.H> - [..] - Fl_Native_File_Chooser fnfc; - fnfc.title("Pick a file"); - fnfc.type(Fl_Native_File_Chooser::BROWSE_FILE); - fnfc.filter("Text\t*.txt\n" - "C Files\t*.{cxx,h,c}"); - fnfc.directory("/var/tmp"); // default directory to use - // Show native chooser - switch ( fnfc.show() ) { - case -1: printf("ERROR: %s\n", fnfc.errmsg()); break; // ERROR - case 1: printf("CANCEL\n"); break; // CANCEL - default: printf("PICKED: %s\n", fnfc.filename()); break; // FILE CHOSEN - } - \endcode - - <B>Platform Specific Caveats</B> - - - Under X windows, it's best if you call Fl_File_Icon::load_system_icons() - at the start of main(), to enable the nicer looking file browser widgets. - Use the static public attributes of class Fl_File_Chooser to localize - the browser. - - Some operating systems support certain OS specific options; see - Fl_Native_File_Chooser::options() for a list. - - \image html Fl_Native_File_Chooser.png "The Fl_Native_File_Chooser on different platforms." - \image latex Fl_Native_File_Chooser.png "The Fl_Native_File_Chooser on different platforms" width=14cm - -*/ class FL_EXPORT Fl_Native_File_Chooser { public: enum Type { _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
