Str 1171: added documentation for Fl_Toggle_Button

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@4884 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Matthias Melcher 2006-03-29 14:40:44 +00:00
parent 467bedb315
commit 668f127024
4 changed files with 43 additions and 2 deletions

View File

@ -10,7 +10,7 @@
+----<B>Fl_Button</B>
|
+----<A href=Fl_Check_Button.html#Fl_Check_Button>Fl_Check_Button</A>, <A href=Fl_Light_Button.html#Fl_Light_Button>Fl_Light_Button</A>, <A href=Fl_Repeat_Button.html#Fl_Repeat_Button>Fl_Repeat_Button</A>,
<A href=Fl_Return_Button.html#Fl_Return_Button>Fl_Return_Button</A>, <A href=Fl_Round_Button.html#Fl_Round_Button>Fl_Round_Button</A>
<A href=Fl_Return_Button.html#Fl_Return_Button>Fl_Return_Button</A>, <A href=Fl_Round_Button.html#Fl_Round_Button>Fl_Round_Button</A>, <A href=Fl_Toggle_Button.html#Fl_Toggle_Button>Fl_Toggle_Button</A>
</PRE>
</UL>
<H3>Include Files</H3>

View File

@ -0,0 +1,39 @@
<HTML><BODY>
<!-- NEW PAGE -->
<H2><A name=Fl_Toggle_Button>class Fl_Toggle_Button</A></H2>
<HR>
<H3>Class Hierarchy</H3>
<UL>
<PRE>
<A href=Fl_Button.html#Fl_Button>Fl_Button</A>
|
+----<B>Fl_Toggle_Button</B>
</PRE>
</UL>
<H3>Include Files</H3>
<UL>
<PRE>
#include &lt;FL/Fl_Toggle_Button.H&gt;
</PRE>
</UL>
<H3>Description</H3>
<P>The toggle button is a push button that needs to be clicked once
to toggle on, and one more time to toggle off.
The <TT>Fl_Toggle_Button</TT> subclass displays the &quot;on&quot; state by
drawing a pushed-in button.</P>
<P>Buttons generate callbacks when they are clicked by the user. You
control exactly when and how by changing the values for <TT>type()</TT>
and <TT>when()</TT>.
<H3>Methods</H3>
<UL>
<LI><A href=#Fl_Toggle_Button.Fl_Toggle_Button>Fl_Toggle_Button</A></LI>
<LI><A href=#Fl_Toggle_Button.~Fl_Toggle_Button>~Fl_Toggle_Button</A></LI>
</UL>
<H4><A name=Fl_Toggle_Button.Fl_Toggle_Button>
Fl_Toggle_Button::Fl_Toggle_Button(int x, int y, int w, int h, const char
*label = 0)</A></H4>
Creates a new <TT>Fl_Toggle_Button</TT> widget using the given
position, size, and label string.
<H4><A name=Fl_Toggle_Button.~Fl_Toggle_Button>
Fl_Toggle_Button::~Fl_Toggle_Button()</A></H4>
The destructor deletes the toggle button. </BODY></HTML>

View File

@ -85,6 +85,7 @@ Fl_Text_Editor.html
Fl_Tile.html
Fl_Tiled_Image.html
Fl_Timer.html
Fl_Toggle_Button.html
Fl_Tooltip.html
Fl_Valuator.html
Fl_Value_Input.html

View File

@ -54,8 +54,8 @@ description of the <TT>fl_</TT> functions, see
<A HREF="Fl_Menu_.html">Fl_Menu_</A><BR>
<A HREF="Fl_Menu_Item.html">Fl_Menu_Item</A><BR>
<A HREF="Fl_Menu_Window.html">Fl_Menu_Window</A><BR>
</TD><TD>
<A HREF="Fl_Multi_Browser.html">Fl_Multi_Browser</A><BR>
</TD><TD>
<A HREF="Fl_Multiline_Input.html">Fl_Multiline_Input</A><BR>
<A HREF="Fl_Multiline_Output.html">Fl_Multiline_Output</A><BR>
<A HREF="Fl_Output.html">Fl_Output</A><BR>
@ -87,6 +87,7 @@ description of the <TT>fl_</TT> functions, see
<A HREF="Fl_Tiled_Image.html">Fl_Tiled_Image</A><BR>
<A HREF="Fl_Tile.html">Fl_Tile</A><BR>
<A HREF="Fl_Timer.html">Fl_Timer</A><BR>
<A HREF="Fl_Toggle_Button.html">Fl_Toggle_Button</A><BR>
<A HREF="Fl_Tooltip.html">Fl_Tooltip</A><BR>
<A HREF="Fl_Valuator.html">Fl_Valuator</A><BR>
<A HREF="Fl_Value_Input.html">Fl_Value_Input</A><BR>