mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-09 23:34:20 +00:00
118 lines
4.7 KiB
C++
118 lines
4.7 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 contains an on/off toggle button.
|
|
|
|
This type of property component can be used if you have a boolean value to
|
|
toggle on/off.
|
|
|
|
@see PropertyComponent
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API BooleanPropertyComponent : public PropertyComponent
|
|
{
|
|
protected:
|
|
//==============================================================================
|
|
/** Creates a button component.
|
|
|
|
If you use this constructor, you must override the getState() and setState()
|
|
methods.
|
|
|
|
@param propertyName the property name to be passed to the PropertyComponent
|
|
@param buttonTextWhenTrue the text shown in the button when the value is true
|
|
@param buttonTextWhenFalse the text shown in the button when the value is false
|
|
*/
|
|
BooleanPropertyComponent (const String& propertyName,
|
|
const String& buttonTextWhenTrue,
|
|
const String& buttonTextWhenFalse);
|
|
|
|
public:
|
|
/** Creates a button component.
|
|
|
|
Note that if you call this constructor then you must use the Value to interact with the
|
|
button state, and you can't override the class with your own setState or getState methods.
|
|
If you want to use getState and setState, call the other constructor instead.
|
|
|
|
@param valueToControl a Value object that this property should refer to.
|
|
@param propertyName the property name to be passed to the PropertyComponent
|
|
@param buttonText the text shown in the ToggleButton component
|
|
*/
|
|
BooleanPropertyComponent (const Value& valueToControl,
|
|
const String& propertyName,
|
|
const String& buttonText);
|
|
|
|
/** Destructor. */
|
|
~BooleanPropertyComponent() override;
|
|
|
|
//==============================================================================
|
|
/** Called to change the state of the boolean value. */
|
|
virtual void setState (bool newState);
|
|
|
|
/** Must return the current value of the property. */
|
|
virtual bool getState() const;
|
|
|
|
//==============================================================================
|
|
/** A set of colour IDs to use to change the colour of various aspects of the component.
|
|
|
|
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour()
|
|
methods.
|
|
|
|
@see Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
|
|
*/
|
|
enum ColourIds
|
|
{
|
|
backgroundColourId = 0x100e801, /**< The colour to fill the background of the button area. */
|
|
outlineColourId = 0x100e803, /**< The colour to use to draw an outline around the text area. */
|
|
};
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void paint (Graphics&) override;
|
|
/** @internal */
|
|
void refresh() override;
|
|
|
|
private:
|
|
ToggleButton button;
|
|
String onText, offText;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (BooleanPropertyComponent)
|
|
};
|
|
|
|
} // namespace juce
|