FLTK 1.3.4
Fl_Valuator.H
1 //
2 // "$Id: Fl_Valuator.H 11316 2016-03-08 13:42:59Z AlbrechtS $"
3 //
4 // Valuator header file for the Fast Light Tool Kit (FLTK).
5 //
6 // Copyright 1998-2016 by Bill Spitzak and others.
7 //
8 // This library is free software. Distribution and use rights are outlined in
9 // the file "COPYING" which should have been included with this file. If this
10 // file is missing or damaged, see the license at:
11 //
12 // http://www.fltk.org/COPYING.php
13 //
14 // Please report all bugs and problems on the following page:
15 //
16 // http://www.fltk.org/str.php
17 //
18 
19 /* \file
20  Fl_Valuator widget . */
21 
22 #ifndef Fl_Valuator_H
23 #define Fl_Valuator_H
24 
25 #ifndef Fl_Widget_H
26 #include "Fl_Widget.H"
27 #endif
28 
29 // shared type() values for classes that work in both directions:
30 #define FL_VERTICAL 0
31 #define FL_HORIZONTAL 1
32 
33 
49 class FL_EXPORT Fl_Valuator : public Fl_Widget {
50 
51  double value_;
52  double previous_value_;
53  double min, max; // truncates to this range *after* rounding
54  double A; int B; // rounds to multiples of A/B, or no rounding if A is zero
55 
56 protected:
58  int horizontal() const {return type()& FL_HORIZONTAL;}
59  Fl_Valuator(int X, int Y, int W, int H, const char* L);
60 
62  double previous_value() const {return previous_value_;}
64  void handle_push() {previous_value_ = value_;}
65  double softclamp(double);
66  void handle_drag(double newvalue);
67  void handle_release(); // use drag() value
68  virtual void value_damage(); // cause damage() due to value() changing
70  void set_value(double v) {value_ = v;}
71 
72 public:
73 
75  void bounds(double a, double b) {min=a; max=b;}
77  double minimum() const {return min;}
79  void minimum(double a) {min = a;}
81  double maximum() const {return max;}
83  void maximum(double a) {max = a;}
104  void range(double a, double b) {min = a; max = b;}
106  void step(int a) {A = a; B = 1;}
108  void step(double a, int b) {A = a; B = b;}
109  void step(double s);
121  double step() const {return A/B;}
122  void precision(int digits);
123 
125  double value() const {return value_;}
126  int value(double);
127 
128  virtual int format(char*);
129  double round(double); // round to nearest multiple of step
130  double clamp(double); // keep in range
131  double increment(double, int); // add n*step to value
132 };
133 
134 #endif
135 
136 //
137 // End of "$Id: Fl_Valuator.H 11316 2016-03-08 13:42:59Z AlbrechtS $".
138 //
Fl_Widget is the base class for all widgets in FLTK.
Definition: Fl_Widget.H:101
The Fl_Valuator class controls a single floating-point value and provides a consistent interface to s...
Definition: Fl_Valuator.H:49
void maximum(double a)
Sets the maximum value for the valuator.
Definition: Fl_Valuator.H:83
double previous_value() const
Gets the previous floating point value before an event changed it.
Definition: Fl_Valuator.H:62
double minimum() const
Gets the minimum value for the valuator.
Definition: Fl_Valuator.H:77
int horizontal() const
Tells if the valuator is an FL_HORIZONTAL one.
Definition: Fl_Valuator.H:58
void set_value(double v)
Sets the current floating point value.
Definition: Fl_Valuator.H:70
void step(double a, int b)
See double Fl_Valuator::step() const.
Definition: Fl_Valuator.H:108
Fl_Widget, Fl_Label classes .
double maximum() const
Gets the maximum value for the valuator.
Definition: Fl_Valuator.H:81
void handle_push()
Stores the current value in the previous value.
Definition: Fl_Valuator.H:64
void minimum(double a)
Sets the minimum value for the valuator.
Definition: Fl_Valuator.H:79
void bounds(double a, double b)
Sets the minimum (a) and maximum (b) values for the valuator widget.
Definition: Fl_Valuator.H:75
double value() const
Gets the floating point(double) value.
Definition: Fl_Valuator.H:125
void range(double a, double b)
Sets the minimum and maximum values for the valuator.
Definition: Fl_Valuator.H:104
void step(int a)
See double Fl_Valuator::step() const.
Definition: Fl_Valuator.H:106
double step() const
Gets or sets the step value.
Definition: Fl_Valuator.H:121
uchar type() const
Gets the widget type.
Definition: Fl_Widget.H:274