STR #2113: added sorting and a few other functions to Fl_Browser_.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6600 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

2 files changed, 29 insertions, 0 deletions

diff --git a/FL/Fl_Browser.H b/FL/Fl_Browser.H
index e0fa132c2..428bd20d2 100644
--- a/FL/Fl_Browser.H
+++ b/FL/Fl_Browser.H
@@ -86,6 +86,7 @@ protected:
   void* item_first() const ;
   void* item_next(void*) const ;
   void* item_prev(void*) const ;
+  void* item_last()const ;
   int item_selected(void*) const ;
   void item_select(void*, int);
   int item_height(void*) const ;
@@ -93,6 +94,9 @@ protected:
   void item_draw(void*, int, int, int, int) const ;
   int full_height() const ;
   int incr_height() const ;
+  const char *item_text(void *item) const;
+  void item_swap(void *a, void *b) { swap((FL_BLINE*)a, (FL_BLINE*)b); }
+  void *item_at(int ix) const { return (void*)find_line(ix); }
 
   FL_BLINE* find_line(int) const ;
   FL_BLINE* _remove(int) ;
diff --git a/FL/Fl_Browser_.H b/FL/Fl_Browser_.H
index 30c62962c..f89383618 100644
--- a/FL/Fl_Browser_.H
+++ b/FL/Fl_Browser_.H
@@ -48,6 +48,9 @@
 #define FL_HOLD_BROWSER		2	/**< type() of Fl_Hold_Browser */
 #define FL_MULTI_BROWSER	3	/**< type() of Fl_Multi_Browser */
 
+#define FL_SORT_ASC		0	/**< sort browser items in ascending alphabetic order. */
+#define FL_SORT_DESC		1	/**< sort in descending order */
+
 /**
   This is the base for browsers.  To be useful it must be
   subclassed and several virtual functions defined.  The Forms-compatible
@@ -94,6 +97,8 @@ protected:
     virtual void *item_next(void *) const = 0;
   /** This method must be provided by the subclass to return the item in the list before p. */
     virtual void *item_prev(void *) const = 0;
+  /** This method can be provided by the subclass to return the ilast item in the list. */
+    virtual void *item_last() const { return 0L; }
   /** 
     This method must be provided by the subclass to return the height of the
     item p in pixels.  Allow for two additional pixels for the list
@@ -113,6 +118,18 @@ protected:
     and h.
   */
   virtual void item_draw(void *,int,int,int,int) const = 0;
+  /**
+    This optional function returns a string that may be used for sorting. 
+   */
+  virtual const char *item_text(void *item) const { return 0L; }
+  /**
+    This optional function is required for sorting browser items.
+   */
+  virtual void item_swap(void*, void*) { }
+  /**
+    Return the item a specified index. 
+   */
+  virtual void *item_at(int) const { return 0L; }
   // you don't have to provide these but it may help speed it up:
   virtual int full_width() const ;	// current width of all items
   virtual int full_height() const ;	// current height of all items
@@ -271,6 +288,14 @@ public:
   */
   void scrollbar_left() {scrollbar.align(FL_ALIGN_LEFT);}
 
+  /**
+   Sort the items in the browser.
+   item_swap(void*, void*) and item_text(void*) must be implemented for this call.
+   \param[in] flags no flags were defined yet. Sorting in descending order and 
+                    sorting while ignoring case come to mind.
+   */
+  void sort(int flags=0);
+
 };
 
 #endif