JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
juce_BooleanPropertyComponent.cpp
Go to the documentation of this file.
1 /*
2 ==============================================================================
3
4 This file is part of the JUCE library.
5 Copyright (c) 2022 - Raw Material Software Limited
6
7 JUCE is an open source library subject to commercial or open-source
8 licensing.
9
10 By using JUCE, you agree to the terms of both the JUCE 7 End-User License
11 Agreement and JUCE Privacy Policy.
12
13 End User License Agreement: www.juce.com/juce-7-licence
14 Privacy Policy: www.juce.com/juce-privacy-policy
15
16 Or: You may also use this code under the terms of the GPL v3 (see
17 www.gnu.org/licenses).
18
19 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
20 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
21 DISCLAIMED.
22
23 ==============================================================================
24*/
25
26namespace juce
27{
28
32 : PropertyComponent (name),
33 onText (buttonTextWhenTrue),
34 offText (buttonTextWhenFalse)
35{
36 addAndMakeVisible (button);
37 button.setClickingTogglesState (false);
38 button.onClick = [this] { setState (! getState()); };
39}
40
42 const String& name,
43 const String& buttonText)
44 : PropertyComponent (name),
45 onText (buttonText),
46 offText (buttonText)
47{
48 addAndMakeVisible (button);
49 button.setClickingTogglesState (false);
52 button.setClickingTogglesState (true);
53}
54
58
63
65{
66 return button.getToggleState();
67}
68
79
81{
83 button.setButtonText (button.getToggleState() ? onText : offText);
84}
85
86} // namespace juce
virtual void setState(bool newState)
Called to change the state of the boolean value.
void paint(Graphics &) override
Components can override this method to draw their content.
void refresh() override
Updates the property component if the item it refers to has changed.
BooleanPropertyComponent(const String &propertyName, const String &buttonTextWhenTrue, const String &buttonTextWhenFalse)
Creates a button component.
virtual bool getState() const
Must return the current value of the property.
@ backgroundColourId
The colour to fill the background of the button area.
@ outlineColourId
The colour to use to draw an outline around the text area.
bool getToggleState() const noexcept
Returns true if the button is 'on'.
void setToggleState(bool shouldBeOn, NotificationType notification)
A button has an on/off state associated with it, and this changes that.
void setButtonText(const String &newText)
Changes the button's text.
std::function< void()> onClick
You can assign a lambda to this callback object to have it called when the button is clicked.
void setClickingTogglesState(bool shouldAutoToggleOnClick) noexcept
This tells the button to automatically flip the toggle state when the button is clicked.
Value & getToggleStateValue() noexcept
Returns the Value object that represents the button's toggle state.
void addAndMakeVisible(Component *child, int zOrder=-1)
Adds a child component to this one, and also makes the child visible if it isn't already.
Rectangle< int > getBounds() const noexcept
Returns this component's bounding box.
Colour findColour(int colourID, bool inheritFromParent=false) const
Looks for a colour that has been registered with the given colour ID number.
A graphics context, used for drawing a component or image.
void drawRect(int x, int y, int width, int height, int lineThickness=1) const
Draws a rectangular outline, using the current colour or brush.
void fillRect(Rectangle< int > rectangle) const
Fills a rectangle with the current colour or brush.
void setColour(Colour newColour)
Changes the current drawing colour.
A base class for a component that goes in a PropertyPanel and displays one of an item's properties.
void paint(Graphics &) override
The default paint method fills the background and draws a label for the item's name.
The JUCE String class!
Definition juce_String.h:53
Represents a shared variant value.
Definition juce_Value.h:51
void referTo(const Value &valueToReferTo)
Makes this object refer to the same underlying ValueSource as another one.
JUCE Namespace.
@ sendNotification
Requests a notification message, either synchronous or not.
@ dontSendNotification
No notification message should be sent.
Type unalignedPointerCast(void *ptr) noexcept
Casts a pointer to another type via void*, which suppresses the cast-align warning which sometimes ar...
Definition juce_Memory.h:88