summaryrefslogtreecommitdiff
path: root/FL/Fl_Native_File_Chooser.H
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2011-02-05 22:35:51 +0000
committerMatthias Melcher <fltk@matthiasm.com>2011-02-05 22:35:51 +0000
commitb661be27788ef657d4c53e7d214a5ccb65bf83b9 (patch)
tree0e66bc6b2b32b2fdb3f4ec253f76a0b684f83b97 /FL/Fl_Native_File_Chooser.H
parent46518adf5884914f4f6fc3e36bc0c4ed2ebcf846 (diff)
Distille the Native File Chooser files down into a single file. I would like to avoid that the common API runs out of sync between platforms (no code doubling - there was already a mismatch with 'const'), and that the users may wonder which file to include. Please check this on WIN32 and Unix. It does work on OS X.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8378 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Native_File_Chooser.H')
-rw-r--r--FL/Fl_Native_File_Chooser.H206
1 files changed, 203 insertions, 3 deletions
diff --git a/FL/Fl_Native_File_Chooser.H b/FL/Fl_Native_File_Chooser.H
index c4129fd53..3672fedc2 100644
--- a/FL/Fl_Native_File_Chooser.H
+++ b/FL/Fl_Native_File_Chooser.H
@@ -83,20 +83,220 @@
#ifndef FL_NATIVE_FILE_CHOOSER_H
#define FL_NATIVE_FILE_CHOOSER_H
+/* \file
+ Fl_Native_File_Chooser widget. */
+
// Use Windows' chooser
#ifdef WIN32
-#include <FL/Fl_Native_File_Chooser_WIN32.H>
+// #define _WIN32_WINNT 0x0501 // needed for OPENFILENAME's 'FlagsEx'
+#include <stdio.h>
+#include <stdlib.h> // malloc
+#include <windows.h>
+#include <commdlg.h> // OPENFILENAME, GetOpenFileName()
+#include <shlobj.h> // BROWSEINFO, SHBrowseForFolder()
#endif
// Use Apple's chooser
#ifdef __APPLE__
-#include <FL/Fl_Native_File_Chooser_MAC.H>
+#include <FL/filename.H>
+#define MAXFILTERS 80
#endif
// All else falls back to FLTK's own chooser
#if ! defined(__APPLE__) && !defined(WIN32)
-#include <FL/Fl_Native_File_Chooser_FLTK.H>
+#include <FL/Fl_File_Chooser.H>
+#include <unistd.h> // _POSIX_NAME_MAX
+#endif
+
+
+/**
+ 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, use the following include in your code:
+ \code
+ #include <FL/Fl_Native_File_Chooser.H>
+ \endcode
+
+ 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 {
+ BROWSE_FILE = 0, ///< browse files (lets user choose one file)
+ BROWSE_DIRECTORY, ///< browse directories (lets user choose one directory)
+ BROWSE_MULTI_FILE, ///< browse files (lets user choose multiple files)
+ BROWSE_MULTI_DIRECTORY, ///< browse directories (lets user choose multiple directories)
+ BROWSE_SAVE_FILE, ///< browse to save a file
+ BROWSE_SAVE_DIRECTORY ///< browse to save a directory
+ };
+ enum Option {
+ NO_OPTIONS = 0x0000, ///< no options enabled
+ SAVEAS_CONFIRM = 0x0001, ///< Show native 'Save As' overwrite confirm dialog (if supported)
+ NEW_FOLDER = 0x0002, ///< Show 'New Folder' icon (if supported)
+ PREVIEW = 0x0004 ///< enable preview mode
+ };
+ /** Localizable message */
+ static const char *file_exists_message;
+
+public:
+ Fl_Native_File_Chooser(int val=BROWSE_FILE);
+ ~Fl_Native_File_Chooser();
+
+ // Public methods
+ void type(int);
+ int type() const;
+ void options(int);
+ int options() const;
+ int count() const;
+ const char *filename() const;
+ const char *filename(int i) const;
+ void directory(const char *val);
+ const char *directory() const;
+ void title(const char *);
+ const char* title() const;
+ const char *filter() const;
+ void filter(const char *);
+ int filters() const;
+ void filter_value(int i);
+ int filter_value() const;
+ void preset_file(const char*);
+ const char* preset_file() const;
+ const char *errmsg() const;
+ int show();
+
+#ifdef WIN32
+private:
+ int _btype; // kind-of browser to show()
+ int _options; // general options
+ OPENFILENAMEW _ofn; // GetOpenFileName() & GetSaveFileName() struct
+ BROWSEINFO _binf; // SHBrowseForFolder() struct
+ char **_pathnames; // array of pathnames
+ int _tpathnames; // total pathnames
+ char *_directory; // default pathname to use
+ char *_title; // title for window
+ char *_filter; // user-side search filter
+ char *_parsedfilt; // filter parsed for Windows dialog
+ int _nfilters; // number of filters parse_filter counted
+ char *_preset_file; // the file to preselect
+ char *_errmsg; // error message
+
+ // Private methods
+ void errmsg(const char *msg);
+
+ void clear_pathnames();
+ void set_single_pathname(const char *s);
+ void add_pathname(const char *s);
+
+ void FreePIDL(ITEMIDLIST *pidl);
+ void ClearOFN();
+ void ClearBINF();
+ void Win2Unix(char *s);
+ void Unix2Win(char *s);
+ int showfile();
+ static int CALLBACK Dir_CB(HWND win, UINT msg, LPARAM param, LPARAM data);
+ int showdir();
+
+ void parse_filter(const char *);
+ void clear_filters();
+ void add_filter(const char *, const char *);
+#endif
+
+#ifdef __APPLE__
+private:
+ int _btype; // kind-of browser to show()
+ int _options; // general options
+ void *_panel;
+ char **_pathnames; // array of pathnames
+ int _tpathnames; // total pathnames
+ char *_directory; // default pathname to use
+ char *_title; // title for window
+ char *_preset_file; // the 'save as' filename
+
+ char *_filter; // user-side search filter, eg:
+ // C Files\t*.[ch]\nText Files\t*.txt"
+
+ char *_filt_names; // filter names (tab delimited)
+ // eg. "C Files\tText Files"
+
+ char *_filt_patt[MAXFILTERS];
+ // array of filter patterns, eg:
+ // _filt_patt[0]="*.{cxx,h}"
+ // _filt_patt[1]="*.txt"
+
+ int _filt_total; // parse_filter() # of filters loaded
+ int _filt_value; // index of the selected filter
+ char *_errmsg; // error message
+
+ // Private methods
+ void errmsg(const char *msg);
+ void clear_pathnames();
+ void set_single_pathname(const char *s);
+ int get_saveas_basename(void);
+ void clear_filters();
+ void add_filter(const char *, const char *);
+ void parse_filter(const char *from);
+ int post();
+#endif
+
+#if ! defined(__APPLE__) && !defined(WIN32)
+private:
+ int _btype; // kind-of browser to show()
+ int _options; // general options
+ int _nfilters;
+ char *_filter; // user supplied filter
+ char *_parsedfilt; // parsed filter
+ int _filtvalue; // selected filter
+ char *_preset_file;
+ char *_prevvalue; // Returned filename
+ char *_directory;
+ char *_errmsg; // error message
+ Fl_File_Chooser *_file_chooser;
+
+ // Private methods
+ void errmsg(const char *msg);
+ int type_fl_file(int);
+ void parse_filter();
+ void keeplocation();
+ int exist_dialog();
#endif
+};
+
#endif /*FL_NATIVE_FILE_CHOOSER_H*/