WYSWYG editor for JUCE GUIs including Visualisers
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
GuiItem Class Referenceabstract

The GuiItem class will draw borders and descriptions around widgets, if defined. More...

#include <foleys_GuiItem.h>

+ Inheritance diagram for GuiItem:

Public Member Functions

 GuiItem (MagicGUIBuilder &builder, juce::ValueTree node)
 
 ~GuiItem () override
 
virtual juce::Component * getWrappedComponent ()=0
 Allows accessing the Component inside that GuiItem.
 
virtual void update ()=0
 In update() the ValueTree properties should be used to set all properties to the component.
 
virtual void updateColours ()
 Set colours in the wrapped Component to the value from the stylesheet and palette.
 
virtual std::vector< SettableProperty > getSettableProperties () const
 Override this to return each settable option the designer should be able to configure on your component.
 
void setColourTranslation (std::vector< std::pair< juce::String, int > > mapping)
 For each factory you can register a translation table, which will forward the colours from the Stylesheet to the Components.
 
juce::StringArray getColourNames () const
 Return the names of configurable colours.
 
virtual juce::String getControlledParameterID (juce::Point< int >)
 Returns the parameterID that is controlled from this component.
 
juce::var getProperty (const juce::Identifier &property)
 Look up a value through the DOM and CSS.
 
MagicGUIState & getMagicState ()
 
virtual GuiItem * findGuiItemWithId (const juce::String &name)
 Lookup a Component through the tree.
 
void updateInternal ()
 Reread properties from the config ValueTree.
 
void paint (juce::Graphics &g) final
 
void resized () override
 
virtual bool isContainer () const
 
virtual void createSubComponents ()
 
virtual void updateLayout ()
 This will trigger a recalculation of the children layout regardless of resized.
 
LayoutType getParentsLayoutType () const
 Returns the layout type this item is managed by.
 
void configureFlexBoxItem (const juce::ValueTree &node)
 Parse the values and set it to the FlexBox::Item for layouting.
 
void configurePosition (const juce::ValueTree &node)
 
juce::Rectangle< int > resolvePosition (juce::Rectangle< int > parent)
 Calculates the position according to the parent area.
 
juce::Rectangle< int > getClientBounds () const
 Returns the bounds of the wrapped Component.
 
juce::String getTabCaption (const juce::String &defaultName) const
 
juce::Colour getTabColour () const
 
juce::FlexItem & getFlexItem ()
 
void itemDragEnter (const juce::DragAndDropTarget::SourceDetails &details) override
 
void itemDragExit (const juce::DragAndDropTarget::SourceDetails &details) override
 
void paintOverChildren (juce::Graphics &g) override
 
virtual GuiItem * findGuiItem (const juce::ValueTree &node)
 Seeks recursively for a GuiItem.
 
virtual void setEditMode (bool shouldEdit)
 This method sets the GUI in edit mode, that allows to drag the components around.
 
void setDraggable (bool selected)
 
void mouseDown (const juce::MouseEvent &event) override
 
void mouseDrag (const juce::MouseEvent &event) override
 
void mouseUp (const juce::MouseEvent &event) override
 
bool isInterestedInDragSource (const juce::DragAndDropTarget::SourceDetails &dragSourceDetails) override
 
void itemDropped (const juce::DragAndDropTarget::SourceDetails &dragSourceDetails) override
 

Public Attributes

MagicGUIBuilder & magicBuilder
 

Protected Attributes

juce::ValueTree configNode
 
Decorator decorator
 
juce::FlexItem flexItem { juce::FlexItem (*this).withFlex (1.0f) }
 
std::vector< std::pair< juce::String, int > > colourTranslation
 

Detailed Description

The GuiItem class will draw borders and descriptions around widgets, if defined.

It also owns the Component and the Attachment, in case the Component is connected to an AudioProcessorValueTreeState.

Constructor & Destructor Documentation

◆ GuiItem()

GuiItem ( MagicGUIBuilder & builder,
juce::ValueTree node )

References configNode, and magicBuilder.

Referenced by ComboBoxItem::ComboBoxItem(), Container::Container(), DrumpadItem::DrumpadItem(), Container::findGuiItem(), findGuiItem(), Container::findGuiItemWithId(), findGuiItemWithId(), KeyboardItem::KeyboardItem(), LabelItem::LabelItem(), LevelMeterItem::LevelMeterItem(), ListBoxItem::ListBoxItem(), MidiLearnItem::MidiLearnItem(), PlotItem::PlotItem(), SliderItem::SliderItem(), TextButtonItem::TextButtonItem(), ToggleButtonItem::ToggleButtonItem(), and XYDraggerItem::XYDraggerItem().

◆ ~GuiItem()

~GuiItem ( )
override

References magicBuilder.

Member Function Documentation

◆ getWrappedComponent()

virtual juce::Component * getWrappedComponent ( )
pure virtual

Allows accessing the Component inside that GuiItem.

Don't keep this pointer!

Implemented in ComboBoxItem, Container, DrumpadItem, KeyboardItem, LabelItem, LevelMeterItem, ListBoxItem, MidiLearnItem, PlotItem, SliderItem, TextButtonItem, ToggleButtonItem, and XYDraggerItem.

Referenced by resized(), setEditMode(), and updateColours().

◆ update()

virtual void update ( )
pure virtual

In update() the ValueTree properties should be used to set all properties to the component.

You can use the magicBuilder to resolve properties from CSS. The Colours will be handled by default.

Implemented in ComboBoxItem, Container, DrumpadItem, KeyboardItem, LabelItem, LevelMeterItem, ListBoxItem, MidiLearnItem, PlotItem, SliderItem, TextButtonItem, ToggleButtonItem, and XYDraggerItem.

Referenced by updateInternal().

◆ updateColours()

void updateColours ( )
virtual

Set colours in the wrapped Component to the value from the stylesheet and palette.

Reimplemented in Container, and RootItem.

References colourTranslation, configNode, decorator, getWrappedComponent(), and magicBuilder.

Referenced by updateInternal().

◆ getSettableProperties()

virtual std::vector< SettableProperty > getSettableProperties ( ) const
virtual

Override this to return each settable option the designer should be able to configure on your component.

Reimplemented in ComboBoxItem, DrumpadItem, LabelItem, LevelMeterItem, ListBoxItem, PlotItem, SliderItem, TextButtonItem, ToggleButtonItem, and XYDraggerItem.

◆ setColourTranslation()

void setColourTranslation ( std::vector< std::pair< juce::String, int > > mapping)

For each factory you can register a translation table, which will forward the colours from the Stylesheet to the Components.

References colourTranslation.

Referenced by ComboBoxItem::ComboBoxItem(), DrumpadItem::DrumpadItem(), KeyboardItem::KeyboardItem(), LabelItem::LabelItem(), LevelMeterItem::LevelMeterItem(), PlotItem::PlotItem(), SliderItem::SliderItem(), TextButtonItem::TextButtonItem(), ToggleButtonItem::ToggleButtonItem(), and XYDraggerItem::XYDraggerItem().

◆ getColourNames()

juce::StringArray getColourNames ( ) const

Return the names of configurable colours.

References colourTranslation.

◆ getControlledParameterID()

virtual juce::String getControlledParameterID ( juce::Point< int > )
virtual

Returns the parameterID that is controlled from this component.

To allow multiple return values depending of the position where the drop arrived there is the drop position supplied.

Reimplemented in SliderItem.

Referenced by itemDragEnter(), and itemDropped().

◆ getProperty()

juce::var getProperty ( const juce::Identifier & property)

Look up a value through the DOM and CSS.

References configNode, and magicBuilder.

Referenced by DrumpadItem::update(), KeyboardItem::update(), LabelItem::update(), PlotItem::update(), SliderItem::update(), TextButtonItem::update(), ToggleButtonItem::update(), and XYDraggerItem::update().

◆ getMagicState()

MagicGUIState & getMagicState ( )

References magicBuilder.

Referenced by DrumpadItem::DrumpadItem(), KeyboardItem::KeyboardItem(), ComboBoxItem::update(), Container::update(), LabelItem::update(), LevelMeterItem::update(), ListBoxItem::update(), PlotItem::update(), SliderItem::update(), TextButtonItem::update(), ToggleButtonItem::update(), and XYDraggerItem::update().

◆ findGuiItemWithId()

GuiItem * findGuiItemWithId ( const juce::String & name)
virtual

Lookup a Component through the tree.

It will return the first with that id regardless if there is another one. We discourage using that function, because that Component can be deleted and recreated at any time without notice.

Reimplemented in Container.

References configNode, and GuiItem().

Referenced by MagicGUIBuilder::findGuiItemWithId().

◆ updateInternal()

void updateInternal ( )

Reread properties from the config ValueTree.

References configNode, configureFlexBoxItem(), configurePosition(), decorator, magicBuilder, setEditMode(), update(), and updateColours().

◆ paint()

void paint ( juce::Graphics & g)
final

References decorator.

◆ resized()

void resized ( )
override

References getClientBounds(), and getWrappedComponent().

Referenced by updateLayout().

◆ isContainer()

virtual bool isContainer ( ) const
virtual

Reimplemented in Container.

◆ createSubComponents()

virtual void createSubComponents ( )
virtual

Reimplemented in Container.

◆ updateLayout()

void updateLayout ( )
virtual

This will trigger a recalculation of the children layout regardless of resized.

Reimplemented in Container.

References resized().

◆ getParentsLayoutType()

LayoutType getParentsLayoutType ( ) const

Returns the layout type this item is managed by.

References foleys::Contents.

Referenced by setDraggable().

◆ configureFlexBoxItem()

void configureFlexBoxItem ( const juce::ValueTree & node)

Parse the values and set it to the FlexBox::Item for layouting.

References flexItem, and magicBuilder.

Referenced by updateInternal().

◆ configurePosition()

void configurePosition ( const juce::ValueTree & node)

References configurePosition(), and magicBuilder.

Referenced by configurePosition(), and updateInternal().

◆ resolvePosition()

juce::Rectangle< int > resolvePosition ( juce::Rectangle< int > parent)

Calculates the position according to the parent area.

◆ getClientBounds()

juce::Rectangle< int > getClientBounds ( ) const

Returns the bounds of the wrapped Component.

This is the GuiItems bounds reduced by margin, padding and the caption, if one was set.

References decorator.

Referenced by resized(), and Container::updateLayout().

◆ getTabCaption()

juce::String getTabCaption ( const juce::String & defaultName) const

References decorator.

◆ getTabColour()

juce::Colour getTabColour ( ) const

References decorator.

◆ getFlexItem()

juce::FlexItem & getFlexItem ( )

References flexItem.

◆ itemDragEnter()

void itemDragEnter ( const juce::DragAndDropTarget::SourceDetails & details)
override

References getControlledParameterID(), and magicBuilder.

◆ itemDragExit()

void itemDragExit ( const juce::DragAndDropTarget::SourceDetails & details)
override

◆ paintOverChildren()

void paintOverChildren ( juce::Graphics & g)
override

References configNode, and magicBuilder.

◆ findGuiItem()

GuiItem * findGuiItem ( const juce::ValueTree & node)
virtual

Seeks recursively for a GuiItem.

Reimplemented in Container.

References configNode, and GuiItem().

Referenced by MagicGUIBuilder::findGuiItem().

◆ setEditMode()

void setEditMode ( bool shouldEdit)
virtual

This method sets the GUI in edit mode, that allows to drag the components around.

Reimplemented in Container.

References getWrappedComponent().

Referenced by Container::setEditMode(), and updateInternal().

◆ setDraggable()

void setDraggable ( bool selected)

References configNode, foleys::Contents, getParentsLayoutType(), and magicBuilder.

◆ mouseDown()

void mouseDown ( const juce::MouseEvent & event)
override

References magicBuilder.

◆ mouseDrag()

void mouseDrag ( const juce::MouseEvent & event)
override

◆ mouseUp()

void mouseUp ( const juce::MouseEvent & event)
override

References configNode, and magicBuilder.

◆ isInterestedInDragSource()

bool isInterestedInDragSource ( const juce::DragAndDropTarget::SourceDetails & dragSourceDetails)
override

◆ itemDropped()

void itemDropped ( const juce::DragAndDropTarget::SourceDetails & dragSourceDetails)
override

References configNode, getControlledParameterID(), and magicBuilder.

Member Data Documentation

◆ magicBuilder

MagicGUIBuilder& magicBuilder

Referenced by Container::configureFlexBox(), configureFlexBoxItem(), configurePosition(), Container::createSubComponents(), getMagicState(), getProperty(), ComboBoxItem::getSettableProperties(), LabelItem::getSettableProperties(), LevelMeterItem::getSettableProperties(), ListBoxItem::getSettableProperties(), PlotItem::getSettableProperties(), SliderItem::getSettableProperties(), TextButtonItem::getSettableProperties(), ToggleButtonItem::getSettableProperties(), XYDraggerItem::getSettableProperties(), GuiItem(), itemDragEnter(), itemDropped(), mouseDown(), mouseUp(), paintOverChildren(), setDraggable(), Container::update(), LabelItem::update(), PlotItem::update(), TextButtonItem::update(), ToggleButtonItem::update(), Container::updateColours(), updateColours(), RootItem::updateColours(), updateInternal(), and ~GuiItem().

◆ configNode

juce::ValueTree configNode
protected

Referenced by Container::createSubComponents(), Container::findGuiItem(), findGuiItem(), Container::findGuiItemWithId(), findGuiItemWithId(), SliderItem::getControlledParameterID(), getProperty(), ComboBoxItem::getSettableProperties(), DrumpadItem::getSettableProperties(), LabelItem::getSettableProperties(), LevelMeterItem::getSettableProperties(), ListBoxItem::getSettableProperties(), PlotItem::getSettableProperties(), SliderItem::getSettableProperties(), TextButtonItem::getSettableProperties(), ToggleButtonItem::getSettableProperties(), XYDraggerItem::getSettableProperties(), GuiItem(), itemDropped(), mouseUp(), paintOverChildren(), setDraggable(), ComboBoxItem::update(), Container::update(), LabelItem::update(), LevelMeterItem::update(), ListBoxItem::update(), PlotItem::update(), SliderItem::update(), TextButtonItem::update(), ToggleButtonItem::update(), XYDraggerItem::update(), Container::updateColours(), updateColours(), RootItem::updateColours(), and updateInternal().

◆ decorator

Decorator decorator
protected

Referenced by getClientBounds(), getTabCaption(), getTabColour(), paint(), Container::updateColours(), updateColours(), updateInternal(), and Container::updateLayout().

◆ flexItem

juce::FlexItem flexItem { juce::FlexItem (*this).withFlex (1.0f) }
protected

Referenced by configureFlexBoxItem(), and getFlexItem().

◆ colourTranslation

std::vector<std::pair<juce::String, int> > colourTranslation
protected

Referenced by getColourNames(), setColourTranslation(), and updateColours().

The documentation for this class was generated from the following files: