SliderItem Class Reference

Inheritance diagram for SliderItem:

Public Member Functions
	SliderItem (MagicGUIBuilder &builder, const juce::ValueTree &node)
void	update () override
	In update() the ValueTree properties should be used to set all properties to the component. More...
std::vector< SettableProperty >	getSettableProperties () const override
	Override this to return each settable option the designer should be able to configure on your component. More...
juce::String	getControlledParameterID (juce::Point< int >) override
	Returns the parameterID that is controlled from this component. More...
juce::Component *	getWrappedComponent () override
	Allows accessing the Component inside that GuiItem. More...
Public Member Functions inherited from GuiItem
	GuiItem (MagicGUIBuilder &builder, juce::ValueTree node)
	~GuiItem () override
virtual void	updateColours ()
	Set colours in the wrapped Component to the value from the stylesheet and palette. More...
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. More...
juce::StringArray	getColourNames () const
	Return the names of configurable colours. More...
juce::var	getProperty (const juce::Identifier &property)
	Look up a value through the DOM and CSS. More...
MagicGUIState &	getMagicState ()
virtual GuiItem *	findGuiItemWithId (const juce::String &name)
	Lookup a Component through the tree. More...
void	updateInternal ()
	Reread properties from the config ValueTree. More...
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. More...
LayoutType	getParentsLayoutType () const
	Returns the layout type this item is managed by. More...
void	configureFlexBoxItem (const juce::ValueTree &node)
	Parse the values and set it to the FlexBox::Item for layouting. More...
void	configurePosition (const juce::ValueTree &node)
juce::Rectangle< int >	resolvePosition (juce::Rectangle< int > parent)
	Calculates the position according to the parent area. More...
juce::Rectangle< int >	getClientBounds () const
	Returns the bounds of the wrapped Component. More...
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. More...
bool	isInterestedInDragSource (const juce::DragAndDropTarget::SourceDetails &dragSourceDetails) override
void	itemDropped (const juce::DragAndDropTarget::SourceDetails &dragSourceDetails) override

Static Public Attributes
static const juce::Identifier	pSliderType { "slider-type" }
static const juce::StringArray	pSliderTypes { "auto", "linear-horizontal", "linear-vertical", "rotary", "rotary-horizontal-vertical", "inc-dec-buttons" }
static const juce::Identifier	pSliderTextBox { "slider-textbox" }
static const juce::StringArray	pTextBoxPositions { "no-textbox", "textbox-above", "textbox-below", "textbox-left", "textbox-right" }
static const juce::Identifier	pValue { "value" }
static const juce::Identifier	pMinValue { "min-value" }
static const juce::Identifier	pMaxValue { "max-value" }
static const juce::Identifier	pInterval { "interval" }
static const juce::Identifier	pSuffix { "suffix" }
static const juce::Identifier	pFilmStrip { "filmstrip" }
static const juce::Identifier	pNumImages { "num-filmstrip-images" }

Additional Inherited Members
Public Attributes inherited from GuiItem
MagicGUIBuilder &	magicBuilder
Protected Attributes inherited from GuiItem
juce::ValueTree	configNode
Decorator	decorator
juce::FlexItem	flexItem { juce::FlexItem (*this).withFlex (1.0f) }
std::vector< std::pair< juce::String, int > >	colourTranslation

Constructor & Destructor Documentation

SliderItem()

SliderItem	(	MagicGUIBuilder &	builder,
		const juce::ValueTree &	node
	)

References GuiItem::setColourTranslation().

Member Function Documentation

update()

void update ( )

overridevirtual

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.

Implements GuiItem.

References GuiItem::configNode, MagicGUIState::createAttachment(), SliderItem::getControlledParameterID(), GuiItem::getMagicState(), GuiItem::getProperty(), SliderItem::pFilmStrip, SliderItem::pInterval, SliderItem::pMaxValue, SliderItem::pMinValue, SliderItem::pNumImages, SliderItem::pSliderTextBox, SliderItem::pSliderType, SliderItem::pSliderTypes, SliderItem::pSuffix, SliderItem::pTextBoxPositions, SliderItem::pValue, AutoOrientationSlider::setAutoOrientation(), AutoOrientationSlider::setFilmStrip(), and AutoOrientationSlider::setNumImages().

getSettableProperties()

std::vector<SettableProperty> getSettableProperties ( ) const

overridevirtual

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

Reimplemented from GuiItem.

References SettableProperty::Choice, GuiItem::configNode, MagicGUIBuilder::createChoicesMenuLambda(), MagicGUIBuilder::createParameterMenuLambda(), MagicGUIBuilder::createPropertiesMenuLambda(), GuiItem::magicBuilder, SettableProperty::Number, SliderItem::pFilmStrip, SliderItem::pInterval, SliderItem::pMaxValue, SliderItem::pMinValue, SliderItem::pNumImages, SliderItem::pSliderTextBox, SliderItem::pSliderType, SliderItem::pSliderTypes, SliderItem::pSuffix, SliderItem::pTextBoxPositions, SliderItem::pValue, and SettableProperty::Text.

getControlledParameterID()

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

overridevirtual

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 from GuiItem.

References GuiItem::configNode.

Referenced by SliderItem::update().

getWrappedComponent()

juce::Component* getWrappedComponent ( )

overridevirtual

Allows accessing the Component inside that GuiItem.

Don't keep this pointer!

Implements GuiItem.

Member Data Documentation

pSliderType

const juce::Identifier pSliderType { "slider-type" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pSliderTypes

const juce::StringArray pSliderTypes { "auto", "linear-horizontal", "linear-vertical", "rotary", "rotary-horizontal-vertical", "inc-dec-buttons" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pSliderTextBox

const juce::Identifier pSliderTextBox { "slider-textbox" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pTextBoxPositions

const juce::StringArray pTextBoxPositions { "no-textbox", "textbox-above", "textbox-below", "textbox-left", "textbox-right" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pValue

const juce::Identifier pValue { "value" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pMinValue

const juce::Identifier pMinValue { "min-value" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pMaxValue

const juce::Identifier pMaxValue { "max-value" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pInterval

const juce::Identifier pInterval { "interval" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pSuffix

const juce::Identifier pSuffix { "suffix" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pFilmStrip

const juce::Identifier pFilmStrip { "filmstrip" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

pNumImages

const juce::Identifier pNumImages { "num-filmstrip-images" }

static

Referenced by SliderItem::getSettableProperties(), and SliderItem::update().

---

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

• foleys_MagicJUCEFactories.cpp