FLTK 1.4.0
Loading...
Searching...
No Matches
Fl_Native_File_Chooser.H
Go to the documentation of this file.
1//
2// FLTK native OS file chooser widget
3//
4// Copyright 2004 Greg Ercolano.
5// Copyright 2005-2024 by Bill Spitzak and others.
6//
7// This library is free software. Distribution and use rights are outlined in
8// the file "COPYING" which should have been included with this file. If this
9// file is missing or damaged, see the license at:
10//
11// https://www.fltk.org/COPYING.php
12//
13// Please see the following page on how to report bugs and issues:
14//
15// https://www.fltk.org/bugs.php
16//
17
21/* Implementation note:
22
23 class Fl_Native_File_Chooser <== public API used by applications
24
25 class Fl_Native_File_Chooser_Driver <== virtual API that a platform may implement
26 this API has a do-nothing default implementation
27
28 class Fl_Native_File_Chooser_FLTK_Driver <== this API implementation is the default FLTK file chooser
29 class Fl_GTK_Native_File_Chooser_Driver <== this API implementation runs a GTK file chooser
30 class Fl_Kdialog_Native_File_Chooser_Driver <== this API implementation runs a KDE file chooser
31 it is determined at run-time if the GTK dynamic libraries are available
32 and the KDE file chooser runs under the KDE desktop
33
34 class Fl_Quartz_Native_File_Chooser_Driver <== this API implementation runs a Mac OS X file chooser
35
36 class Fl_WinAPI_Native_File_Chooser_Driver <== this API implementation runs a Windows file chooser
37
38
39 Each platform must implement the constructor of the Fl_Native_File_Chooser class.
40 This particular implementation:
41
42 Fl_Native_File_Chooser::Fl_Native_File_Chooser(int val) {
43 platform_fnfc = new Fl_Native_File_Chooser_FLTK_Driver(val);
44 }
45
46 can be used by any platform.
47 No more code is required. The cross-platform Fl_Native_File_Chooser_FLTK.cxx file must be compiled in libfltk,
48 and the default FLTK file chooser will be used.
49
50 This other implementation:
51 Fl_Native_File_Chooser::Fl_Native_File_Chooser(int val) {
52 platform_fnfc = 0;
53 }
54 can be used by a platform that needs no file chooser.
55 */
56
57#ifndef FL_NATIVE_FILE_CHOOSER_H
58#define FL_NATIVE_FILE_CHOOSER_H
59
60#include <FL/Fl_Export.H>
61#include <FL/Fl_File_Chooser.H>
62
63class Fl_Native_File_Chooser_Driver;
64
131class FL_EXPORT Fl_Native_File_Chooser {
132private:
133 Fl_Native_File_Chooser_Driver *platform_fnfc;
134public:
143 enum Option {
144 NO_OPTIONS = 0x0000,
145 SAVEAS_CONFIRM = 0x0001,
146 NEW_FOLDER = 0x0002,
147 PREVIEW = 0x0004,
148 USE_FILTER_EXT = 0x0008
149 };
150 static const char *file_exists_message;
151
157 Fl_Native_File_Chooser(int val = BROWSE_FILE); // each platorm implements it
159 void type(int t);
160 int type() const ;
161 void options(int o);
162 int options() const;
163 int count() const;
164 const char *filename() const ;
165 const char *filename(int i) const ;
166 void directory(const char *val) ;
167 const char *directory() const;
168 void title(const char *t);
169 const char* title() const;
170 const char *filter() const ;
171 void filter(const char *f);
172 int filters() const ;
173 void filter_value(int i) ;
174 int filter_value() const ;
175 void preset_file(const char*f) ;
176 const char* preset_file() const;
177 const char *errmsg() const ;
178 int show() ;
179 };
180
193class Fl_Native_File_Chooser_Driver {
194protected:
195 static void chrcat(char *s, char c);
196 static char *strapp(char *s, const char *val);
197 static char *strfree(char *val);
198 static char *strnew(const char *val);
199public:
200 Fl_Native_File_Chooser_Driver(int) {}
201 virtual ~Fl_Native_File_Chooser_Driver() {}
202 virtual void type(int) {}
203 virtual int type() const {return 0;}
204 virtual void options(int) {}
205 virtual int options() const {return 0;}
206 virtual int count() const {return 0;}
207 virtual const char *filename() const {return 0;}
208 virtual const char *filename(int) const {return 0;}
209 virtual void directory(const char *) {}
210 virtual const char *directory() const {return 0;}
211 virtual void title(const char *) {}
212 virtual const char* title() const {return 0;}
213 virtual const char *filter() const {return 0;}
214 virtual void filter(const char *) {}
215 virtual int filters() const {return 0;}
216 virtual void filter_value(int) {}
217 virtual int filter_value() const {return 0;}
218 virtual void preset_file(const char*) {}
219 virtual const char* preset_file() const {return 0;}
220 virtual const char *errmsg() const {return 0;}
221 virtual int show() {return 1;}
222};
223
235class Fl_Native_File_Chooser_FLTK_Driver : public Fl_Native_File_Chooser_Driver {
236private:
237 void errmsg(const char *msg);
238 int type_fl_file(int val);
239 int exist_dialog();
240 void parse_filter();
241protected:
242 int _btype; // kind-of browser to show()
243 int _options; // general options
244 int _nfilters;
245 char *_filter; // user supplied filter
246 char *_parsedfilt; // parsed filter
247 int _filtvalue; // selected filter
248 char *_preset_file;
249 char *_prevvalue; // Returned filename
250 char *_directory;
251 char *_errmsg; // error message
252 Fl_File_Chooser *_file_chooser;
253public:
254 Fl_Native_File_Chooser_FLTK_Driver(int val);
255 virtual ~Fl_Native_File_Chooser_FLTK_Driver();
256 void type(int t) FL_OVERRIDE;
257 int type() const FL_OVERRIDE;
258 void options(int o) FL_OVERRIDE;
259 int options() const FL_OVERRIDE;
260 int count() const FL_OVERRIDE;
261 const char *filename() const FL_OVERRIDE;
262 const char *filename(int i) const FL_OVERRIDE;
263 void directory(const char *val) FL_OVERRIDE;
264 const char *directory() const FL_OVERRIDE;
265 void title(const char *t) FL_OVERRIDE;
266 const char* title() const FL_OVERRIDE;
267 const char *filter() const FL_OVERRIDE;
268 void filter(const char *f) FL_OVERRIDE;
269 int filters() const FL_OVERRIDE;
270 void filter_value(int i) FL_OVERRIDE;
271 int filter_value() const FL_OVERRIDE;
272 void preset_file(const char*f) FL_OVERRIDE;
273 const char* preset_file() const FL_OVERRIDE;
274 const char *errmsg() const FL_OVERRIDE;
275 int show() FL_OVERRIDE;
276};
277
284#endif /*FL_NATIVE_FILE_CHOOSER_H*/
The Fl_File_Chooser widget displays a standard file selection dialog that supports various selection ...
Definition Fl_File_Chooser.H:43
This class lets an FLTK application easily and consistently access the operating system's native file...
Definition Fl_Native_File_Chooser.H:131
static const char * file_exists_message
Localizable message.
Definition Fl_Native_File_Chooser.H:150
Type
Definition Fl_Native_File_Chooser.H:135
@ BROWSE_DIRECTORY
browse directories (lets user choose one directory)
Definition Fl_Native_File_Chooser.H:137
@ BROWSE_MULTI_FILE
browse files (lets user choose multiple files)
Definition Fl_Native_File_Chooser.H:138
@ BROWSE_SAVE_FILE
browse to save a file
Definition Fl_Native_File_Chooser.H:140
@ BROWSE_MULTI_DIRECTORY
browse directories (lets user choose multiple directories)
Definition Fl_Native_File_Chooser.H:139
Option
Definition Fl_Native_File_Chooser.H:143
#define FL_OVERRIDE
This macro makes it safe to use the C++11 keyword override with older compilers.
Definition fl_attr.h:46