Updated Fl_Browser documentation

Added widget hierarchy to Appendix A.

Fixed doubled-up fl_input and fl_choice links (names are not
case sensitive...)

Added FLUID tutorial from Craig P. Earls (none of the sources yet,
just the docos and images)


git-svn-id: file:///fltk/svn/fltk/trunk@258 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

documentation/Fl_Browser.html

@@ -50,39 +50,31 @@ subclass of <TT>Fl_Browser_</TT>. </P>
 <CENTER>
 <TABLE width=90%>
 <TR><TD align=left valign=top>
-<UL>
 <LI><A href=#Fl_Browser.Fl_Browser>Fl_Browser</A></LI>
 <LI><A href=#Fl_Browser.~Fl_Browser>~Fl_Browser</A></LI>
 <LI><A href=#Fl_Browser.add>add</A></LI>
+<LI><A href=#Fl_Browser.bottomline>bottomline</A></LI>
 <LI><A href=#Fl_Browser.clear>clear</A></LI>
-</UL>
 </TD><TD align=left valign=top>
-<UL>
 <LI><A href=#Fl_Browser.column_char>column_char</A></LI>
 <LI><A href=#Fl_Browser.column_widths>column_widths</A></LI>
 <LI><A href=#Fl_Browser.data>data</A></LI>
 <LI><A href=#Fl_Browser.format_char>format_char</A></LI>
-</UL>
 </TD><TD align=left valign=top>
-<UL>
 <LI><A href=#Fl_Browser.hide>hide</A></LI>
 <LI><A href=#Fl_Browser.insert>insert</A></LI>
 <LI><A href=#Fl_Browser.load>load</A></LI>
-<LI><A href=#Fl_Browser.move>move</A></LI>
-</UL>
+<LI><A href=#Fl_Browser.middleline>middleline</A></LI>
 </TD><TD align=left valign=top>
-<UL>
+<LI><A href=#Fl_Browser.move>move</A></LI>
 <LI><A href=#Fl_Browser.position>position</A></LI>
 <LI><A href=#Fl_Browser.remove>remove</A></LI>
 <LI><A href=#Fl_Browser.show>show</A></LI>
-<LI><A href=#Fl_Browser.size>size</A></LI>
-</UL>
 </TD><TD align=left valign=top>
-<UL>
+<LI><A href=#Fl_Browser.size>size</A></LI>
 <LI><A href=#Fl_Browser.text>text</A></LI>
 <LI><A href=#Fl_Browser.topline>topline</A></LI>
 <LI><A href=#Fl_Browser.visible>visible</A></LI>
-</UL>
 </TD></TR>
 </TABLE>
 </CENTER>
@@ -97,6 +89,8 @@ int, const char * = 0)</A></H4>
 the <TT>strdup()</TT> function.  It may also be <TT>NULL</TT> to make a 
 blank line.  The <TT>void *</TT> argument is returned as the <TT>data()</TT>
  of the new item. 
+<H4><A name=Fl_Browser.bottomline>void Fl_Browser::bottomline(int n)</A></H4>
+Scrolls the browser so the bottom line in the browser is <TT>n</TT>.
 <H4><A name=Fl_Browser.clear>void Fl_Browser::clear()</A></H4>
  Remove all the lines in the browser. 
 <H4><A name=Fl_Browser.column_char>uchar Fl_Browser::column_char() const
@@ -170,6 +164,8 @@ string then this just clears the browser.  This returns zero if there
 was any error in opening or reading the file, in which case <TT>errno</TT>
  is set to the system error.  The <TT>data()</TT> of each line is set 
 to <TT>NULL</TT>. 
+<H4><A name=Fl_Browser.middleline>void Fl_Browser::middleline(int n)</A></H4>
+Scrolls the browser so the middle line in the browser is <TT>n</TT>.
 <H4><A name=Fl_Browser.move>void Fl_Browser::move(int to, int from)</A></H4>
  Line <TT>from</TT> is removed and reinserted at <TT>to</TT>; <TT>to</TT>
  is calculated after the line is removed. 
@@ -178,6 +174,7 @@ to <TT>NULL</TT>.
  The first form returns the current vertical scrollbar position, where 
 0 corresponds to the top.  If there is not vertical scrollbar then this 
 will always return 0. 
+<P>The second form sets the vertical scrollbar position to <TT>p</TT>. </P>
 <H4><A name=Fl_Browser.remove>void Fl_Browser::remove(int n)</A></H4>
  Remove line <TT>n</TT> and make the browser one line shorter. 
 <H4><A name=Fl_Browser.show>void Fl_Browser::show(int n)</A></H4>
@@ -192,9 +189,8 @@ out of range it returns <TT>NULL</TT>.
 <P>The second form sets the text for line <TT>n</TT>. </P>
 <H4><A name=Fl_Browser.topline>int Fl_Browser::topline() const
 <BR> void Fl_Browser::topline(int n)</A></H4>
- The first form returns the current top line in the browser. If there 
+The first form returns the current top line in the browser. If there 
 is no vertical scrollbar then this will always return 1. 
-<P>The second form sets the top line in the browser to <TT>n</TT>. </P>
-<P>The second form sets the vertical scrollbar position to <TT>p</TT>. </P>
+<P>The second form scrolls the browser so the top line in the browser is <TT>n</TT>.</P>
 <H4><A name=Fl_Browser.visible>int Fl_Browser::visible(int n) const</A></H4>
- Returns a non-zero value if line <TT>n</TT> is visible. </BODY></HTML>
+ Returns a non-zero value if line <TT>n</TT> is visible. </BODY></HTML>

documentation/editor.html

@@ -186,7 +186,7 @@ void delete_cb(void) {
 </PRE>
 </UL>
 <H3>find_cb()</H3>
- This callback function asks for a search string using the <A href=functions.html#fl_input>
+ This callback function asks for a search string using the <A href=functions.html#fl_input2>
 <TT>fl_input()</TT></A> convenience function and then calls the <TT>
 find2_cb()</TT> function to find the string: 
 <UL>

documentation/functions.html

@@ -48,7 +48,7 @@ button and waits for the user to hit a button.  The return value is 1
 if the user hits Yes, 0 if they pick No.  The enter key is a shortcut 
 for Yes and ESC is a shortcut for No. 
 <P ALIGN=CENTER><IMG src=./fl_ask.gif border=1></P>
-<H3><A name=fl_choice>int fl_choice(const char *q, const char *b0, 
+<H3><A name=fl_choice2>int fl_choice(const char *q, const char *b0, 
 const char *b1, const char *b2, ...)</A></H3>
 
  Shows the message with three buttons below it marked with the strings
@@ -59,7 +59,7 @@ positioned &quot;backwards&quot; You can hide buttons by passing
 <TT>NULL</TT> as their labels.
 
 <P ALIGN=CENTER><IMG src=./fl_choice.gif border=1></P>
-<H3><A name=fl_input>const char *fl_input(const char *label, const char 
+<H3><A name=fl_input2>const char *fl_input(const char *label, const char 
 *deflt = 0, ...)</A></H3>
  Pops up a window displaying a string, lets the user edit it, and 
 return the new value.  The cancel button returns <TT>NULL</TT>. <I>The 

documentation/widgets.html

@@ -5,12 +5,11 @@ This appendix describes all of the widget classes in FLTK.  For a
 description of the <TT>fl_</TT> functions and <TT>Fl::</TT> methods, 
 see <A href=functions.html#functions>Appendix B</A>.
 
-<H2>List of Classes</H2>
+<H2>Alphabetical List of Classes</H2>
 
 <CENTER><TABLE WIDTH=80%>
 <TR ALIGN=LEFT VALIGN=TOP>
 <TD>
-<UL>
 <A HREF=Fl_Adjuster.html#Fl_Adjuster>Fl_Adjuster</A><BR>
 <A HREF=Fl_Box.html#Fl_Box>Fl_Box</A><BR>
 <A HREF=Fl_Browser.html#Fl_Browser>Fl_Browser</A><BR>
@@ -18,7 +17,7 @@ see <A href=functions.html#functions>Appendix B</A>.
 <A HREF=Fl_Button.html#Fl_Button>Fl_Button</A><BR>
 <A HREF=Fl_Chart.html#Fl_Chart>Fl_Chart</A><BR>
 <A HREF=Fl_Check_Button.html#Fl_Check_Button>Fl_Check_Button</A><BR>
-<A HREF=functions.html#Fl_Choice>Fl_Choice</A><BR>
+<A HREF=Fl_Choice.html#Fl_Choice>Fl_Choice</A><BR>
 <A HREF=Fl_Clock.html#Fl_Clock>Fl_Clock</A><BR>
 <A HREF=Fl_Color_Chooser.html#Fl_Color_Chooser>Fl_Color_Chooser</A><BR>
 <A HREF=Fl_Counter.html#Fl_Counter>Fl_Counter</A><BR>
@@ -73,4 +72,87 @@ see <A href=functions.html#functions>Appendix B</A>.
 </TR>
 </TABLE></CENTER>
 
+<H2>Class Hierarchy</H2>
+
+<UL>
+  <LI><A HREF=Fl_End.html#Fl_End>Fl_End</A>
+  <LI><A HREF=Fl_Widget.html#Fl_Widget>Fl_Widget</A>
+  <UL>
+    <LI><A HREF=Fl_Box.html#Fl_Box>Fl_Box</A>
+    <LI><A HREF=Fl_Browser_.html#Fl_Browser_>Fl_Browser_</A>
+    <UL>
+      <LI><A HREF=Fl_Browser.html#Fl_Browser>Fl_Browser</A>
+      <UL>
+	<LI><A HREF=Fl_Hold_Browser.html#Fl_Hold_Browser>Fl_Hold_Browser</A>
+	<LI><A HREF=Fl_Multi_Browser.html#Fl_Multi_Browser>Fl_Multi_Browser</A>
+	<LI><A HREF=Fl_Select_Browser.html#Fl_Select_Browser>Fl_Select_Browser</A>
+      </UL>
+    </UL>
+    <LI><A HREF=Fl_Button.html#Fl_Button>Fl_Button</A>
+    <UL>
+      <LI><A HREF=Fl_Check_Button.html#Fl_Check_Button>Fl_Check_Button</A>
+      <LI><A HREF=Fl_Light_Button.html#Fl_Light_Button>Fl_Light_Button</A>
+      <LI><A HREF=Fl_Repeat_Button.html#Fl_Repeat_Button>Fl_Repeat_Button</A>
+      <LI><A HREF=Fl_Return_Button.html#Fl_Return_Button>Fl_Return_Button</A>
+      <LI><A HREF=Fl_Round_Button.html#Fl_Round_Button>Fl_Round_Button</A>
+    </UL>
+    <LI><A HREF=Fl_Chart.html#Fl_Chart>Fl_Chart</A>
+    <LI><A HREF=Fl_Clock.html#Fl_Clock>Fl_Clock</A>
+    <LI><A HREF=Fl_Color_Chooser.html#Fl_Color_Chooser>Fl_Color_Chooser</A>
+    <LI><A HREF=Fl_Free.html#Fl_Free>Fl_Free</A>
+    <LI><A HREF=Fl_Group.html#Fl_Group>Fl_Group</A>
+    <UL>
+      <LI><A HREF=Fl_Pack.html#Fl_Pack>Fl_Pack</A>
+      <LI><A HREF=Fl_Scroll.html#Fl_Scroll>Fl_Scroll</A>
+      <LI><A HREF=Fl_Tabs.html#Fl_Tabs>Fl_Tabs</A>
+      <LI><A HREF=Fl_Tile.html#Fl_Tile>Fl_Tile</A>
+      <LI><A HREF=Fl_Window.html#Fl_Window>Fl_Window</A>
+      <UL>
+	<LI><A HREF=Fl_Double_Window.html#Fl_Double_Window>Fl_Double_Window</A>
+	<LI><A HREF=Fl_Gl_Window.html#Fl_Gl_Window>Fl_Gl_Window</A>
+	<LI><A HREF=Fl_Menu_Window.html#Fl_Menu_Window>Fl_Menu_Window</A>
+	<LI><A HREF=Fl_Overlay_Window.html#Fl_Overlay_Window>Fl_Overlay_Window</A>
+	<LI><A HREF=Fl_Single_Window.html#Fl_Single_Window>Fl_Single_Window</A>
+      </UL>
+    </UL>
+    <LI><A HREF=Fl_Input_.html#Fl_Input_>Fl_Input_</A>
+    <UL>
+      <LI><A HREF=Fl_Input.html#Fl_Input>Fl_Input</A>
+      <UL>
+	<LI><A HREF=Fl_Float_Input.html#Fl_Float_Input>Fl_Float_Input</A>
+	<LI><A HREF=Fl_Int_Input.html#Fl_Int_Input>Fl_Int_Input</A>
+	<LI><A HREF=Fl_Multiline_Input.html#Fl_Multiline_Input>Fl_Multiline_Input</A>
+	<LI><A HREF=Fl_Secret_Input.html#Fl_Secret_Input>Fl_Secret_Input</A>
+      </UL>
+      <LI><A HREF=Fl_Output.html#Fl_Output>Fl_Output</A>
+      <UL>
+	<LI><A HREF=Fl_Multiline_Output.html#Fl_Multiline_Output>Fl_Multiline_Output</A>
+      </UL>
+    </UL>
+    <LI><A HREF=Fl_Menu_.html#Fl_Menu_>Fl_Menu_</A>
+    <UL>
+      <LI><A HREF=Fl_Choice.html#Fl_Choice>Fl_Choice</A>
+      <LI><A HREF=Fl_Menu_Bar.html#Fl_Menu_Bar>Fl_Menu_Bar</A>
+      <LI><A HREF=Fl_Menu_Button.html#Fl_Menu_Button>Fl_Menu_Button</A>
+    </UL>
+    <LI><A HREF=Fl_Menu_Item.html#Fl_Menu_Item>Fl_Menu_Item</A>
+    <LI><A HREF=Fl_Positioner.html#Fl_Positioner>Fl_Positioner</A>
+    <LI><A HREF=Fl_Timer.html#Fl_Timer>Fl_Timer</A>
+    <LI><A HREF=Fl_Valuator.html#Fl_Valuator>Fl_Valuator</A>
+    <UL>
+      <LI><A HREF=Fl_Adjuster.html#Fl_Adjuster>Fl_Adjuster</A>
+      <LI><A HREF=Fl_Counter.html#Fl_Counter>Fl_Counter</A>
+      <LI><A HREF=Fl_Dial.html#Fl_Dial>Fl_Dial</A>
+      <LI><A HREF=Fl_Roller.html#Fl_Roller>Fl_Roller</A>
+      <LI><A HREF=Fl_Slider.html#Fl_Slider>Fl_Slider</A>
+      <UL>
+	<LI><A HREF=Fl_Scrollbar.html#Fl_Scrollbar>Fl_Scrollbar</A>
+	<LI><A HREF=Fl_Value_Slider.html#Fl_Value_Slider>Fl_Value_Slider</A>
+      </UL>
+      <LI><A HREF=Fl_Value_Input.html#Fl_Value_Input>Fl_Value_Input</A>
+      <LI><A HREF=Fl_Value_Output.html#Fl_Value_Output>Fl_Value_Output</A>
+    </UL>
+  </UL>
+</UL>
+
 </BODY></HTML>