Fl_Spinner.H

//
// Spinner widget for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2017 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//

/* \file
   Fl_Spinner widget . */

#ifndef Fl_Spinner_H
#define Fl_Spinner_H

#include <FL/Enumerations.H>
#include <FL/Fl_Group.H>
#include <FL/Fl_Input.H>
#include <FL/Fl_Repeat_Button.H>

class FL_EXPORT Fl_Spinner : public Fl_Group {

  double        value_;                 // Current value
  double        minimum_;               // Minimum value
  double        maximum_;               // Maximum value
  double        step_;                  // Amount to add/subtract for up/down
  const char    *format_;               // Format string for input field
  int           wrap_;                  // wrap around at bounds (1/0)

private:

  static void sb_cb(Fl_Widget *w, Fl_Spinner *sb); // internal callback
  void update();                                   // update input field

protected:

  // This class works like Fl_Input but ignores FL_Up and FL_Down key
  // presses so they are handled by its parent, the Fl_Spinner widget.
  // See STR #2989.

  class FL_EXPORT Fl_Spinner_Input : public Fl_Input {
  public:
    Fl_Spinner_Input(int X, int Y, int W, int H)
    : Fl_Input(X, Y, W, H) {}
    int handle(int event);              // implemented in src/Fl_Spinner.cxx
  };

  Fl_Spinner_Input input_;              // Input field for the value
  Fl_Repeat_Button
                up_button_,             // Up button
                down_button_;           // Down button

public:

  // Constructor
  Fl_Spinner(int X, int Y, int W, int H, const char *L = 0);
  // Event handling
  int handle(int event);
  // Resize group and subwidgets
  void resize(int X, int Y, int W, int H);

  const char *format() const { return (format_); }

  void format(const char *f) { format_ = f; update(); }

  double maximum() const { return (maximum_); }

  void maximum(double m) { maximum_ = m; }

  double minimum() const { return (minimum_); }

  void minimum(double m) { minimum_ = m; }

  void range(double a, double b) { minimum_ = a; maximum_ = b; }

  // Sets the amount to change the value when the user clicks a button.
  // Docs in src/Fl_Spinner.cxx
  void step(double s);

  double step() const { return (step_); }

  void wrap(int set) { wrap_ = set ? 1 : 0; }

  int wrap() const { return wrap_; }

  Fl_Color textcolor() const { return (input_.textcolor()); }

  void textcolor(Fl_Color c) { input_.textcolor(c); }

  Fl_Font textfont() const { return (input_.textfont()); }

  void textfont(Fl_Font f) { input_.textfont(f); }

  Fl_Fontsize textsize() const { return (input_.textsize()); }

  void textsize(Fl_Fontsize s) { input_.textsize(s); }

  // Sets the numeric representation in the input field.
  // Docs see src/Fl_Spinner.cxx
  void type(uchar v);

  uchar type() const { return (input_.type()); }

  double value() const { return (value_); }

  void value(double v) { value_ = v; update(); }

  void color(Fl_Color v) { input_.color(v); }

  Fl_Color color() const { return(input_.color()); }

  void selection_color(Fl_Color val) { input_.selection_color(val); }

  Fl_Color selection_color() const { return input_.selection_color(); }

  void maximum_size(int m) { if (m > 0) input_.maximum_size(m); }

  int maximum_size() const { return input_.maximum_size(); }
};

#endif // !Fl_Spinner_H