From 58548b781d7c3f0fa6c8c72c63dece888a02ea43 Mon Sep 17 00:00:00 2001
From: Fabien Costantini <fabien@onepost.net>
Date: Sun, 14 Sep 2008 12:45:42 +0000
Subject: Doxygen Documentation WP2 done.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6235 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_File_Browser.H | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'FL/Fl_File_Browser.H')

diff --git a/FL/Fl_File_Browser.H b/FL/Fl_File_Browser.H
index aed0647d5..747bd5c9e 100644
--- a/FL/Fl_File_Browser.H
+++ b/FL/Fl_File_Browser.H
@@ -41,6 +41,7 @@
 // Fl_File_Browser class...
 //
 
+/** The Fl_File_Browser widget displays a list of filenames, optionally with file-specific icons. */
 class FL_EXPORT Fl_File_Browser : public Fl_Browser
 {
   int		filetype_;
@@ -57,20 +58,55 @@ class FL_EXPORT Fl_File_Browser : public Fl_Browser
 public:
   enum { FILES, DIRECTORIES };
 
+  /**
+    The constructor creates the Fl_File_Browser widget at the specified position and size.
+    The destructor destroys the widget and frees all memory that has been allocated.
+  */
   Fl_File_Browser(int, int, int, int, const char * = 0);
 
+  /**    Sets or gets the size of the icons. The default size is 20 pixels.  */
   uchar		iconsize() const { return (iconsize_); };
+  /**    Sets or gets the size of the icons. The default size is 20 pixels.  */
   void		iconsize(uchar s) { iconsize_ = s; redraw(); };
 
+  /**
+    Sets or gets the filename filter. The pattern matching uses
+    the fl_filename_match()
+    function in FLTK.
+  */
   void	filter(const char *pattern);
+  /**
+    Sets or gets the filename filter. The pattern matching uses
+    the fl_filename_match()
+    function in FLTK.
+  */
   const char	*filter() const { return (pattern_); };
 
+  /**
+    Loads the specified directory into the browser. If icons have been
+    loaded then the correct icon is associated with each file in the list.
+    
+    <P>The sort argument specifies a sort function to be used with
+    fl_filename_list().
+  */
   int		load(const char *directory, Fl_File_Sort_F *sort = fl_numericsort);
 
   Fl_Fontsize  textsize() const { return Fl_Browser::textsize(); };
   void		textsize(Fl_Fontsize s) { Fl_Browser::textsize(s); iconsize_ = (uchar)(3 * s / 2); };
 
+  /**
+    Sets or gets the file browser type, FILES or
+    DIRECTORIES. When set to FILES, both
+    files and directories are shown. Otherwise only directories are
+    shown.
+  */
   int		filetype() const { return (filetype_); };
+  /**
+    Sets or gets the file browser type, FILES or
+    DIRECTORIES. When set to FILES, both
+    files and directories are shown. Otherwise only directories are
+    shown.
+  */
   void		filetype(int t) { filetype_ = t; };
 };
 
-- 
cgit v1.2.3