juce/source/src/gui/components/properties/juce_SliderPropertyComponent.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_SLIDERPROPERTYCOMPONENT_JUCEHEADER__
  27 #define __JUCE_SLIDERPROPERTYCOMPONENT_JUCEHEADER__
  28
  29 #include "juce_PropertyComponent.h"
  30 #include "../controls/juce_Slider.h"
  31
  32
  33 //==============================================================================
  34 /**
  35     A PropertyComponent that shows its value as a slider.
  36
  37     @see PropertyComponent, Slider
  38 */
  39 class JUCE_API  SliderPropertyComponent   : public PropertyComponent,
  40                                             private SliderListener  // (can't use Slider::Listener due to idiotic VC2005 bug)
  41 {
  42 protected:
  43     //==============================================================================
  44     /** Creates the property component.
  45
  46         The ranges, interval and skew factor are passed to the Slider component.
  47
  48         If you need to customise the slider in other ways, your constructor can
  49         access the slider member variable and change it directly.
  50     */
  51     SliderPropertyComponent (const String& propertyName,
  52                              double rangeMin,
  53                              double rangeMax,
  54                              double interval,
  55                              double skewFactor = 1.0);
  56
  57 public:
  58     //==============================================================================
  59     /** Creates the property component.
  60
  61         The ranges, interval and skew factor are passed to the Slider component.
  62
  63         If you need to customise the slider in other ways, your constructor can
  64         access the slider member variable and change it directly.
  65     */
  66     SliderPropertyComponent (const Value& valueToControl,
  67                              const String& propertyName,
  68                              double rangeMin,
  69                              double rangeMax,
  70                              double interval,
  71                              double skewFactor = 1.0);
  72
  73     /** Destructor. */
  74     ~SliderPropertyComponent();
  75
  76
  77     //==============================================================================
  78     /** Called when the user moves the slider to change its value.
  79
  80         Your subclass must use this method to update whatever item this property
  81         represents.
  82     */
  83     virtual void setValue (double newValue);
  84
  85     /** Returns the value that the slider should show. */
  86     virtual double getValue() const;
  87
  88
  89     //==============================================================================
  90     /** @internal */
  91     void refresh();
  92     /** @internal */
  93     void sliderValueChanged (Slider*);
  94
  95 protected:
  96     /** The slider component being used in this component.
  97         Your subclass has access to this in case it needs to customise it in some way.
  98     */
  99     Slider slider;
 100
 101 private:
 102     //==============================================================================
 103     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SliderPropertyComponent);
 104 };
 105
 106
 107 #endif   // __JUCE_SLIDERPROPERTYCOMPONENT_JUCEHEADER__