STR #1742: Updated documentation to reflect the true nature of "selection()" and "value()" for Fl_Multi_Browser which can be quite surprisin for unsuspecting customers.

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

1 files changed, 27 insertions, 9 deletions

diff --git a/documentation/Fl_Multi_Browser.html b/documentation/Fl_Multi_Browser.html
index 071f004da..5140bf67e 100644
--- a/documentation/Fl_Multi_Browser.html
+++ b/documentation/Fl_Multi_Browser.html
@@ -38,23 +38,41 @@ methods to add and remove lines from the browser. </P>
 <LI><A href=#Fl_Multi_Browser.select>select</A></LI>
 <LI><A href=#Fl_Multi_Browser.value>value</A></LI>
 </UL>
+
 <H4><A name=Fl_Multi_Browser.Fl_Multi_Browser>
 Fl_Multi_Browser::Fl_Multi_Browser(int x, int y, int w, int h, const
 char *label = 0)</A></H4>
- Creates a new <TT>Fl_Multi_Browser</TT> widget using the given
+
+Creates a new <TT>Fl_Multi_Browser</TT> widget using the given
 position, size, and label string. The default boxtype is <TT>FL_DOWN_BOX</TT>
 .
+
+
 <H4><A name=Fl_Multi_Browser.~Fl_Multi_Browser>virtual
 Fl_Multi_Browser::~Fl_Multi_Browser()</A></H4>
- The destructor <I>also deletes all the items in the list</I>.
+
+The destructor <I>also deletes all the items in the list</I>.
+
+
 <H4><A name=Fl_Multi_Browser.deselect>int Fl_Browser::deselect()</A></H4>
- Deselects all lines.
+
+Deselects all lines.
+
+
 <H4><A name=Fl_Multi_Browser.select>int Fl_Browser::select(int,int=1)
 <BR> int Fl_Browser::selected(int) const</A></H4>
- Selects one or more lines or gets the current selection state of a
+
+Selects one or more lines or gets the current selection state of a
 line.
-<H4><A name=Fl_Multi_Browser.value>int Fl_Browser::value() const
-<BR> void Fl_Browser::value(int)</A></H4>
- Selects a single line or gets the last toggled line. This returns zero
-if no line has been toggled, so be aware that this can happen in a
-callback. </BODY></HTML>
+
+
+<H4><A name=Fl_Multi_Browser.value>void Fl_Browser::value(int)
+<BR> int Fl_Browser::value() const</A></H4>
+
+The first version of this call selects a single line. The second version returns 
+the currently focused item, even if it is not selected. To find all 
+selected items, call 
+<TT><A href=Fl_Multi_Browser.html#Fl_Multi_Browser.select>
+Fl_Multi_Browser::selected()</A></TT> for every item in question.
+ 
+</BODY></HTML>