slider.h

Go to the documentation of this file.

#ifndef SLIDER_CLASS
#define SLIDER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : slider                                                            *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Serves as a horizontal or vertical controller for displaying other parts *
*  of an on-screen object.  These either have a plain bar that can be clicked *
*  on (with a grabbable control knob as well), or they can also have arrows   *
*  for making small position adjustments.                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "dll_wp_active.h"

#include <basis/istring.h>
#include <wp_passive/worker.h>

enum slider_orientation { HORIZONTAL_SLIDER, VERTICAL_SLIDER };

class WP_ACTIVE_CLASS_STYLE slider : public worker
{
public:
  slider(manager &parent, const c_point &origin, const char *name,
      slider_orientation h_or_v, double minValue, double maxValue,
      double granularity = 0.0, const color &foreground = colors::WHITE,
      const color &background = colors::BLACK);
    // creates a sliding control bar.  if granularity is non-zero, then the
    // slider has arrows and can be moved in single granularity sized
    // increments.  Otherwise the slider is moved only by hitting the slider
    // bar.  The default value of the slider after construction is the
    // "minValue" of the slider.

  ~slider();

  IMPLEMENT_CLASS_NAME("slider");

  double value();
  void value(double value, bool trigger_event = true);
    // observes or modifies the position of the slider.  it can be modified
    // with or without an invocation of the slider_moved_event.

  virtual void slider_moved_event(double value);
    // this function is triggered when the user moves the bar of the slider or
    // when a program calls set_value and wants to trigger the callback.

  static void slider_callback(window_handle w, slider *the_slider,
          XmScaleCallbackStruct *call_data);
  static void less_arrow_callback(window_handle w, slider *the_slider,
          XmAnyCallbackStruct *call_data);
  static void more_arrow_callback(window_handle w, slider *the_slider,
          XmAnyCallbackStruct *call_data);

private:
  window_handle maximum_Arrow;
  window_handle minimum_Arrow;
  window_handle slider_w;
  istring maximum_ArrowName;
  istring minimum_ArrowName;
  istring sliderName;

  double current_value;
  double minimum_value;
  double maximum_value;
  double granularity;

  window_handle create_holder
    (window_handle parent, const char *name, slider_orientation h_or_v);

  window_handle create_slider(window_handle parent, const char *name,
      slider_orientation h_or_v, int minimum_value, int maximum_Value);

  void check_value(double value);

  double round_to_granularity
    (double unrounded, double minimum_value, double granularity);

  int real_orientation(slider_orientation to_translate);
};

#endif

---