summaryrefslogtreecommitdiff
path: root/documentation/Fl_Timer.html
blob: 950ec82a346674d7c852ab575a2114f80a24d1f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<html>
<body>

<hr break>

<h2><a name="Fl_Timer">class Fl_Timer</a></h2>

<hr>

<h3>Class Hierarchy</h3>

<ul><pre>
<a href="#Fl_Widget">Fl_Widget</a>
   |
   +----<b>Fl_Timer</b>
</pre></ul>

<h3>Include Files</h3>

<ul><pre>
#include &lt;FL/Fl_Timer.H>
</pre></ul>

<h3>Description</h3>

This is provided only to emulate the Forms Timer widget.  It works by
making a timeout callback every 1/5 second.  This is wasteful and
inaccurate if you just want something to happen a fixed time in the
future.  You should directly call <a
href="#add_timeout"><tt>Fl::add_timeout()</tt></a> instead.

<h3>Methods</h3>

<ul>
	<li><a href="#Fl_Timer.Fl_Timer">Fl_Timer</a>
	<li><a href="#Fl_Timer.~Fl_Timer">~Fl_Timer</a>
	<li><a href="#Fl_Timer.direction">direction</a>
	<li><a href="#Fl_Timer.suspended">suspended</a>
	<li><a href="#Fl_Timer.value">value</a>
</ul>

<h4><a name="Fl_Timer.Fl_Timer">Fl_Timer::Fl_Timer(uchar type, int x, int y, int w, int h, const char *label = 0)</a></h4>

Creates a new <tt>Fl_Timer</tt> widget using the given type, position, size, and
label string. The <tt>type</tt> parameter can be any of the following symbolic
constants:

<ul>
	<li><tt>FL_NORMAL_TIMER</tt> - The timer just does the callback
	and displays the string "Timer" in the widget.

	<li><tt>FL_VALUE_TIMER</tt> - The timer does the callback and
	displays the current timer value in the widget.

	<li><tt>FL_HIDDEN_TIMER</tt> - The timer just does the callback
	and does not display anything.
</ul>

<h4><a name="Fl_Timer.~Fl_Timer">virtual Fl_Timer::~Fl_Timer()</a></h4>

Destroys the timer and removes the timeout.

<h4><a name="Fl_Timer.direction">char direction() const<br>
void direction(char d)</a></h4>

Gets or sets the direction of the timer.  If the direction is zero then
the timer will count up, otherwise it will count down from the initial
<tt>value()</tt>.

<h4><a name="Fl_Timer.suspended">char suspended() const<br>
void suspended(char d)</a></h4>

Gets or sets whether the timer is suspended.

<h4><a name="Fl_Timer.value">float value() const<br>
void value(float)</a></h4>

Gets or sets the current timer value.

</body>
</html>