1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/modules/juce_gui_basics/properties/juce_SliderPropertyComponent.h
2024-04-16 11:39:35 +01:00

116 lines
4.5 KiB
C++

/*
==============================================================================
This file is part of the JUCE framework.
Copyright (c) Raw Material Software Limited
JUCE is an open source framework subject to commercial or open source
licensing.
By downloading, installing, or using the JUCE framework, or combining the
JUCE framework with any other source code, object code, content or any other
copyrightable work, you agree to the terms of the JUCE End User Licence
Agreement, and all incorporated terms including the JUCE Privacy Policy and
the JUCE Website Terms of Service, as applicable, which will bind you. If you
do not agree to the terms of these agreements, we will not license the JUCE
framework to you, and you must discontinue the installation or download
process and cease use of the JUCE framework.
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
Or:
You may also use this code under the terms of the AGPLv3:
https://www.gnu.org/licenses/agpl-3.0.en.html
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
==============================================================================
*/
namespace juce
{
//==============================================================================
/**
A PropertyComponent that shows its value as a slider.
@see PropertyComponent, Slider
@tags{GUI}
*/
class JUCE_API SliderPropertyComponent : public PropertyComponent
{
protected:
//==============================================================================
/** Creates the property component.
The ranges, interval and skew factor are passed to the Slider component.
If you need to customise the slider in other ways, your constructor can
access the slider member variable and change it directly.
*/
SliderPropertyComponent (const String& propertyName,
double rangeMin,
double rangeMax,
double interval,
double skewFactor = 1.0,
bool symmetricSkew = false);
public:
//==============================================================================
/** Creates the property component.
The ranges, interval and skew factor are passed to the Slider component.
If you need to customise the slider in other ways, your constructor can
access the slider member variable and change it directly.
Note that if you call this constructor then you must use the Value to interact with
the value, and you can't override the class with your own setValue or getValue methods.
If you want to use those methods, call the other constructor instead.
*/
SliderPropertyComponent (const Value& valueToControl,
const String& propertyName,
double rangeMin,
double rangeMax,
double interval,
double skewFactor = 1.0,
bool symmetricSkew = false);
/** Destructor. */
~SliderPropertyComponent() override;
//==============================================================================
/** Called when the user moves the slider to change its value.
Your subclass must use this method to update whatever item this property
represents.
*/
virtual void setValue (double newValue);
/** Returns the value that the slider should show. */
virtual double getValue() const;
//==============================================================================
/** @internal */
void refresh() override;
protected:
/** The slider component being used in this component.
Your subclass has access to this in case it needs to customise it in some way.
*/
Slider slider;
private:
//==============================================================================
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (SliderPropertyComponent)
};
} // namespace juce