openshot-audio  0.1.7
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ChoicePropertyComponent Class Reference

#include <juce_ChoicePropertyComponent.h>

Inheritance diagram for ChoicePropertyComponent:
ComboBox::Listener

Classes

class  RemapperValueSource
 

Public Member Functions

 ChoicePropertyComponent (const Value &valueToControl, const String &propertyName, const StringArray &choices, const Array< var > &correspondingValues)
 
 ~ChoicePropertyComponent ()
 
virtual void setIndex (int newIndex)
 
virtual int getIndex () const
 
const StringArraygetChoices () const
 
void refresh ()
 

Protected Member Functions

 ChoicePropertyComponent (const String &propertyName)
 

Protected Attributes

StringArray choices
 

Detailed Description

A PropertyComponent that shows its value as a combo box.

This type of property component contains a list of options and has a combo box to choose one.

Your subclass's constructor must add some strings to the choices StringArray and these are shown in the list.

The getIndex() method will be called to find out which option is the currently selected one. If you call refresh() it will call getIndex() to check whether the value has changed, and will update the combo box if needed.

If the user selects a different item from the list, setIndex() will be called to let your class process this.

See Also
PropertyComponent, PropertyPanel

Constructor & Destructor Documentation

ChoicePropertyComponent::ChoicePropertyComponent ( const String propertyName)
protected

Creates the component. Your subclass's constructor must add a list of options to the choices member variable.

ChoicePropertyComponent::ChoicePropertyComponent ( const Value valueToControl,
const String propertyName,
const StringArray choices,
const Array< var > &  correspondingValues 
)

Creates the component.

Note that if you call this constructor then you must use the Value to interact with the index, and you can't override the class with your own setIndex or getIndex methods. If you want to use those methods, call the other constructor instead.

Parameters
valueToControlthe value that the combo box will read and control
propertyNamethe name of the property
choicesthe list of possible values that the drop-down list will contain
correspondingValuesa list of values corresponding to each item in the 'choices' StringArray. These are the values that will be read and written to the valueToControl value. This array must contain the same number of items as the choices array
ChoicePropertyComponent::~ChoicePropertyComponent ( )

Destructor.

Member Function Documentation

const StringArray & ChoicePropertyComponent::getChoices ( ) const

Returns the list of options.

int ChoicePropertyComponent::getIndex ( ) const
virtual

Returns the index of the item that should currently be shown. This is the index of the item in the choices StringArray that will be shown.

void ChoicePropertyComponent::refresh ( )
void ChoicePropertyComponent::setIndex ( int  newIndex)
virtual

Called when the user selects an item from the combo box.

Your subclass must use this callback to update the value that this component represents. The index is the index of the chosen item in the choices StringArray.

Member Data Documentation

StringArray ChoicePropertyComponent::choices
protected

The list of options that will be shown in the combo box.

Your subclass must populate this array in its constructor. If any empty strings are added, these will be replaced with horizontal separators (see ComboBox::addSeparator() for more info).


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