summaryrefslogtreecommitdiff
path: root/FL/Fl_Native_File_Chooser.H
diff options
context:
space:
mode:
authorManolo Gouy <Manolo>2016-04-23 06:27:31 +0000
committerManolo Gouy <Manolo>2016-04-23 06:27:31 +0000
commite2edfcbe4fc6e24d77bcd74f03fca7d4f27dcb38 (patch)
treea74abf1abb4b3da0f1778fb426dd6ae868ae80c9 /FL/Fl_Native_File_Chooser.H
parentc393fb4fafda7ad3ce2d8187a26f75fa6a874160 (diff)
Add Doxygen definitions to the new Fl_XXX_Driver classes.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11681 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Native_File_Chooser.H')
-rw-r--r--FL/Fl_Native_File_Chooser.H18
1 files changed, 17 insertions, 1 deletions
diff --git a/FL/Fl_Native_File_Chooser.H b/FL/Fl_Native_File_Chooser.H
index a5fd01f43..4a9221573 100644
--- a/FL/Fl_Native_File_Chooser.H
+++ b/FL/Fl_Native_File_Chooser.H
@@ -167,7 +167,12 @@ public:
int show() ;
};
-
+/** Represents the interface between FLTK and a native file chooser.
+ This class is only for internal use by the FLTK library.
+ A platform that wants to provide a native file chooser implements all virtual methods
+ of this class. Each platform supported by FLTK must also implement the constructor of the
+ Fl_Native_File_Chooser class.
+ */
class Fl_Native_File_Chooser_Driver {
protected:
static void chrcat(char *s, char c);
@@ -199,6 +204,17 @@ public:
virtual int show() {return 1;}
};
+/** A cross-platform implementation of Fl_Native_File_Chooser_Driver.
+ This implementation uses a Fl_File_Chooser object as file chooser.
+
+ Any platform can support the Fl_Native_File_Chooser class by implementing
+ its constructor as follows:
+ \code
+ Fl_Native_File_Chooser::Fl_Native_File_Chooser(int type) {
+ platform_fnfc = new Fl_Native_File_Chooser_FLTK_Driver(type);
+ }
+\endcode
+ */
class Fl_Native_File_Chooser_FLTK_Driver : public Fl_Native_File_Chooser_Driver {
private:
void errmsg(const char *msg);