mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-17 00:44:19 +00:00
112 lines
4 KiB
C++
112 lines
4 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library - "Jules' Utility Class Extensions"
|
|
Copyright 2004-11 by Raw Material Software Ltd.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
JUCE can be redistributed and/or modified under the terms of the GNU General
|
|
Public License (Version 2), as published by the Free Software Foundation.
|
|
A copy of the license is included in the JUCE distribution, or can be found
|
|
online at www.gnu.org/licenses.
|
|
|
|
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
To release a closed-source product which uses JUCE, commercial licenses are
|
|
available: visit www.rawmaterialsoftware.com/juce for more information.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
#ifndef __JUCE_GROUPCOMPONENT_JUCEHEADER__
|
|
#define __JUCE_GROUPCOMPONENT_JUCEHEADER__
|
|
|
|
#include "../components/juce_Component.h"
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
A component that draws an outline around itself and has an optional title at
|
|
the top, for drawing an outline around a group of controls.
|
|
|
|
*/
|
|
class JUCE_API GroupComponent : public Component
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a GroupComponent.
|
|
|
|
@param componentName the name to give the component
|
|
@param labelText the text to show at the top of the outline
|
|
*/
|
|
GroupComponent (const String& componentName = String::empty,
|
|
const String& labelText = String::empty);
|
|
|
|
/** Destructor. */
|
|
~GroupComponent();
|
|
|
|
//==============================================================================
|
|
/** Changes the text that's shown at the top of the component. */
|
|
void setText (const String& newText);
|
|
|
|
/** Returns the currently displayed text label. */
|
|
String getText() const;
|
|
|
|
/** Sets the positioning of the text label.
|
|
|
|
(The default is Justification::left)
|
|
|
|
@see getTextLabelPosition
|
|
*/
|
|
void setTextLabelPosition (const Justification& justification);
|
|
|
|
/** Returns the current text label position.
|
|
|
|
@see setTextLabelPosition
|
|
*/
|
|
const Justification getTextLabelPosition() const noexcept { return justification; }
|
|
|
|
//==============================================================================
|
|
/** 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
|
|
{
|
|
outlineColourId = 0x1005400, /**< The colour to use for drawing the line around the edge. */
|
|
textColourId = 0x1005410 /**< The colour to use to draw the text label. */
|
|
};
|
|
|
|
//==============================================================================
|
|
struct Ids
|
|
{
|
|
static const Identifier tagType, text, justification;
|
|
};
|
|
|
|
void refreshFromValueTree (const ValueTree&, ComponentBuilder&);
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void paint (Graphics& g);
|
|
/** @internal */
|
|
void enablementChanged();
|
|
/** @internal */
|
|
void colourChanged();
|
|
|
|
private:
|
|
String text;
|
|
Justification justification;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE (GroupComponent);
|
|
};
|
|
|
|
|
|
#endif // __JUCE_GROUPCOMPONENT_JUCEHEADER__
|