blob: 952273ffbd45d645b956a2beb1d2e5e42c9e4c37 [file] [log] [blame]
DRC2ff39b82011-07-28 08:38:59 +00001//
2// "$Id: Fl_Timer.H 7903 2010-11-28 21:06:39Z matt $"
3//
4// Timer header file for the Fast Light Tool Kit (FLTK).
5//
6// Copyright 1998-2010 by Bill Spitzak and others.
7//
8// This library is free software; you can redistribute it and/or
9// modify it under the terms of the GNU Library General Public
10// License as published by the Free Software Foundation; either
11// version 2 of the License, or (at your option) any later version.
12//
13// This library is distributed in the hope that it will be useful,
14// but WITHOUT ANY WARRANTY; without even the implied warranty of
15// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16// Library General Public License for more details.
17//
18// You should have received a copy of the GNU Library General Public
19// License along with this library; if not, write to the Free Software
20// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21// USA.
22//
23// Please report all bugs and problems on the following page:
24//
25// http://www.fltk.org/str.php
26//
27
28/* \file
29 Fl_Timer widget . */
30
31#ifndef Fl_Timer_H
32#define Fl_Timer_H
33
34#ifndef Fl_Widget_H
35#include "Fl_Widget.H"
36#endif
37
38// values for type():
39#define FL_NORMAL_TIMER 0
40#define FL_VALUE_TIMER 1
41#define FL_HIDDEN_TIMER 2
42
43/**
44 This is provided only to emulate the Forms Timer widget. It works by
45 making a timeout callback every 1/5 second. This is wasteful and
46 inaccurate if you just want something to happen a fixed time in the
47 future. You should directly call
48 Fl::add_timeout() instead.
49*/
50class FL_EXPORT Fl_Timer : public Fl_Widget {
51 static void stepcb(void *);
52 void step();
53 char on, direction_;
54 double delay, total;
55 long lastsec,lastusec;
56protected:
57 void draw();
58public:
59 int handle(int);
60 Fl_Timer(uchar t,int x,int y,int w,int h, const char *l);
61 ~Fl_Timer();
62 void value(double);
63 /** See void Fl_Timer::value(double) */
64 double value() const {return delay>0.0?delay:0.0;}
65 /**
66 Gets or sets the direction of the timer. If the direction is zero
67 then the timer will count up, otherwise it will count down from the
68 initial value().
69 */
70 char direction() const {return direction_;}
71 /**
72 Gets or sets the direction of the timer. If the direction is zero
73 then the timer will count up, otherwise it will count down from the
74 initial value().
75 */
76 void direction(char d) {direction_ = d;}
77 /** Gets or sets whether the timer is suspended. */
78 char suspended() const {return !on;}
79 void suspended(char d);
80};
81
82#endif
83
84//
85// End of "$Id: Fl_Timer.H 7903 2010-11-28 21:06:39Z matt $".
86//
87