STR 1192: Added documentation for Fl_Clock_Output

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@4880 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Matthias Melcher
2006-03-28 23:53:15 +00:00
parent b8bc24764e
commit d490097eaa
5 changed files with 64 additions and 19 deletions
+7 -17
View File
@@ -5,7 +5,7 @@
<H3>Class Hierarchy</H3>
<UL>
<PRE>
<A href=Fl_Widget.html#Fl_Widget>Fl_Widget</A>
<A href=Fl_Clock_Output.html#Fl_Clock_Output>Fl_Clock_Output</A>
|
+----<B>Fl_Clock</B>
</PRE>
@@ -35,23 +35,13 @@ int h, const char *label = 0)</A></H4>
Creates a new <TT>Fl_Clock</TT> widget using the given position, size,
and label string. The default boxtype is <TT>FL_NO_BOX</TT>.
<H4><A name=Fl_Clock.~Fl_Clock>virtual Fl_Clock::~Fl_Clock()</A></H4>
The destructor <I>also deletes all the children</I>. This allows a
whole tree to be deleted at once, without having to keep a pointer to
all the children in the user code. A kludge has been done so the <TT>
Fl_Clock</TT> and all of it's children can be automatic (local)
variables, but you must declare the <TT>Fl_Clock</TT><I>first</I>, so
that it is destroyed last.
<H4><A name=Fl_Clock.hour>int Fl_Clock::hour() const</A></H4>
The destructor removes the clock.
<H4><A name=Fl_Clock.hour>int Fl_Clock_Output::hour() const</A></H4>
Returns the current hour (0 to 23).
<H4><A name=Fl_Clock.minute>int Fl_Clock::minute() const</A></H4>
<H4><A name=Fl_Clock.minute>int Fl_Clock_Output::minute() const</A></H4>
Returns the current minute (0 to 59).
<H4><A name=Fl_Clock.second>int Fl_Clock::second() const</A></H4>
<H4><A name=Fl_Clock.second>int Fl_Clock_Output::second() const</A></H4>
Returns the current second (0 to 60, 60 = leap second).
<H4><A name=Fl_Clock.value>void Fl_Clock::value(ulong v)
<BR> void Fl_Clock::value(int h, int m, int s)
<BR> ulong Fl_Clock::value(void)</A></H4>
The first two forms of <TT>value</TT> set the displayed time to the
given UNIX time value or specific hours, minutes, and seconds.
<P>The third form of <TT>value</TT> returns the displayed time in
seconds since the UNIX epoch (January 1, 1970). </P>
<H4><A name=Fl_Clock.value>ulong Fl_Clock::value(void)</A></H4>
Returns the displayed time in seconds since the UNIX epoch (January 1, 1970). </P>
</BODY></HTML>
+54
View File
@@ -0,0 +1,54 @@
<HTML><BODY>
<!-- NEW PAGE -->
<H2><A name=Fl_Clock>class Fl_Clock_Output</A></H2>
<HR>
<H3>Class Hierarchy</H3>
<UL>
<PRE>
<A href=Fl_Widget.html#Fl_Widget>Fl_Widget</A>
|
+----<B>Fl_Clock_Output</B>
|
+----<A href=Fl_Clock.html#Fl_Clock>Fl_Clock</A>
</PRE>
</UL>
<H3>Include Files</H3>
<UL>
<PRE>
#include &lt;FL/Fl_Clock.H&gt;
</PRE>
</UL>
<H3>Description</H3>
This widget can be used to display a program-supplied time.
The time shown on the clock is not updated.
To display the current time, use <TT><A href=Fl_Clock.html#Fl_Clock>Fl_Clock</A></TT>
instead.</P>
<H3>Methods</H3>
<UL>
<LI><A href=Fl_Clock_Output.Fl_Clock_Output>Fl_Clock_Output</A></LI>
<LI><A href=Fl_Clock_Output.~Fl_Clock_Output>~Fl_Clock_Output</A></LI>
<LI><A href=Fl_Clock_Output.hour>hour</A></LI>
<LI><A href=Fl_Clock_Output.minute>minute</A></LI>
<LI><A href=Fl_Clock_Output.second>second</A></LI>
<LI><A href=Fl_Clock_Output.value>value</A></LI>
</UL>
<H4><A name=Fl_Clock_Output.Fl_Clock_Output>Fl_Clock_Output::Fl_Clock_Output(int x, int y, int w,
int h, const char *label = 0)</A></H4>
Creates a new <TT>Fl_Clock_Output</TT> widget using the given position, size,
and label string. The default boxtype is <TT>FL_NO_BOX</TT>.
<H4><A name=Fl_Clock_Output.~Fl_Clock_Output>virtual Fl_Clock_Output::~Fl_Clock_Output()</A></H4>
The destructor removes the clock.
<H4><A name=Fl_Clock_Output.hour>int Fl_Clock_Output::hour() const</A></H4>
Returns the current hour (0 to 23).
<H4><A name=Fl_Clock_Output.minute>int Fl_Clock_Output::minute() const</A></H4>
Returns the current minute (0 to 59).
<H4><A name=Fl_Clock_Output.second>int Fl_Clock_Output::second() const</A></H4>
Returns the current second (0 to 60, 60 = leap second).
<H4><A name=Fl_Clock_Output.value>void Fl_Clock_Output::value(ulong v)
<BR> void Fl_Clock_Output::value(int h, int m, int s)
<BR> ulong Fl_Clock_Output::value(void)</A></H4>
The first two forms of <TT>value</TT> set the displayed time to the
given UNIX time value or specific hours, minutes, and seconds.
<P>The third form of <TT>value</TT> returns the displayed time in
seconds since the UNIX epoch (January 1, 1970). </P>
</BODY></HTML>
+1 -1
View File
@@ -7,7 +7,7 @@
<PRE>
<B>Fl_Widget</B>
|
+----<A href=Fl_Box.html#Fl_Box>Fl_Box</A>, <A href=Fl_Browser_.html#Fl_Browser_>Fl_Browser_</A>, <A href=Fl_Button.html#Fl_Button>Fl_Button</A>, <A href=Fl_Chart.html#Fl_Chart>Fl_Chart</A>, <A href=Fl_Clock.html#Fl_Clock>Fl_Clock</A>,
+----<A href=Fl_Box.html#Fl_Box>Fl_Box</A>, <A href=Fl_Browser_.html#Fl_Browser_>Fl_Browser_</A>, <A href=Fl_Button.html#Fl_Button>Fl_Button</A>, <A href=Fl_Chart.html#Fl_Chart>Fl_Chart</A>, <A href=Fl_Clock_Output.html#Fl_Clock_Output>Fl_Clock_Output</A>,
<A href=Fl_Free.html#Fl_Free>Fl_Free</A>, <A href=Fl_Group.html#Fl_Group>Fl_Group</A>, <A href=Fl_Input_.html#Fl_Input_>Fl_Input_</A>, <A href=Fl_Menu_.html#Fl_Menu_>Fl_Menu_</A>, <A href=Fl_Positioner.html#Fl_Positioner>Fl_Positioner</A>,
<A HREF="Fl_Progress.html">Fl_Progress</A>, <A href=Fl_Timer.html#Fl_Timer>Fl_Timer</A>, <A href=Fl_Valuator.html#Fl_Valuator>Fl_Valuator</A>
</PRE>
+1
View File
@@ -24,6 +24,7 @@ Fl_Check_Browser.html
Fl_Check_Button.html
Fl_Choice.html
Fl_Clock.html
Fl_Clock_Output.html
Fl_Color_Chooser.html
Fl_Counter.html
Fl_Dial.html
+1 -1
View File
@@ -25,6 +25,7 @@ description of the <TT>fl_</TT> functions, see
<A HREF="Fl_Check_Button.html">Fl_Check_Button</A><BR>
<A HREF="Fl_Choice.html">Fl_Choice</A><BR>
<A HREF="Fl_Clock.html">Fl_Clock</A><BR>
<A HREF="Fl_Clock_Output.html">Fl_Clock_Output</A><BR>
<A HREF="Fl_Color_Chooser.html">Fl_Color_Chooser</A><BR>
<A HREF="Fl_Counter.html">Fl_Counter</A><BR>
<A HREF="Fl_Dial.html">Fl_Dial</A><BR>
@@ -41,7 +42,6 @@ description of the <TT>fl_</TT> functions, see
<A HREF="Fl_Help_Dialog.html">Fl_Help_Dialog</A><BR>
<A HREF="Fl_Help_View.html">Fl_Help_View</A><BR>
<A HREF="Fl_Hold_Browser.html">Fl_Hold_Browser</A><BR>
<A HREF="Fl.html">Fl</A><BR>
<A HREF="Fl_Image.html">Fl_Image</A><BR>
<A HREF="Fl_Input_.html">Fl_Input_</A><BR>
<A HREF="Fl_Input.html">Fl_Input</A><BR>