mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-09 23:34:20 +00:00
102 lines
3.9 KiB
C++
102 lines
3.9 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 button that can be toggled on/off.
|
|
|
|
All buttons can be toggle buttons, but this lets you create one of the
|
|
standard ones which has a tick-box and a text label next to it.
|
|
|
|
@see Button, DrawableButton, TextButton
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API ToggleButton : public Button
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a ToggleButton. */
|
|
ToggleButton();
|
|
|
|
/** Creates a ToggleButton.
|
|
|
|
@param buttonText the text to put in the button (the component's name is also
|
|
initially set to this string, but these can be changed later
|
|
using the setName() and setButtonText() methods)
|
|
*/
|
|
explicit ToggleButton (const String& buttonText);
|
|
|
|
/** Destructor. */
|
|
~ToggleButton() override;
|
|
|
|
//==============================================================================
|
|
/** Resizes the button to fit neatly around its current text.
|
|
The button's height won't be affected, only its width.
|
|
*/
|
|
void changeWidthToFitText();
|
|
|
|
//==============================================================================
|
|
/** A set of colour IDs to use to change the colour of various aspects of the button.
|
|
|
|
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
|
|
{
|
|
textColourId = 0x1006501, /**< The colour to use for the button's text. */
|
|
tickColourId = 0x1006502, /**< The colour to use for the tick mark. */
|
|
tickDisabledColourId = 0x1006503 /**< The colour to use for the disabled tick mark and/or outline. */
|
|
};
|
|
|
|
/** @internal */
|
|
std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
|
|
|
|
protected:
|
|
//==============================================================================
|
|
/** @internal */
|
|
void paintButton (Graphics&, bool, bool) override;
|
|
/** @internal */
|
|
void colourChanged() override;
|
|
|
|
private:
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ToggleButton)
|
|
};
|
|
|
|
} // namespace juce
|