ScriptCombobox

Create a reference to a Combobox UI component and modify its values.

const var Combobox1 = Content.getComponent("Combobox1");

Class methods

addItem

Adds an item to a combo box. Edit on GitHub

ScriptComboBox.addItem( String newName)

addToMacroControl

Adds the knob / button to a macro controller (from 0 to 7). Edit on GitHub

ScriptComboBox.addToMacroControl(int macroIndex)

changed

Call this to indicate that the value has changed (the onControl callback will be executed. Edit on GitHub

ScriptComboBox.changed()

createLocalLookAndFeel

Returns a local look and feel if it was registered before. Edit on GitHub

ScriptComboBox.createLocalLookAndFeel(ScriptContentComponent *contentComponent, Component *componentToRegister)

fadeComponent

Toggles the visibility and fades a component using the global animator. Edit on GitHub

ScriptComboBox.fadeComponent(bool shouldBeVisible, int milliseconds)

get

returns the value of the property. Edit on GitHub

ScriptComboBox.get(String propertyName)

getAllProperties

Returns a list of all property IDs as array. Edit on GitHub

ScriptComboBox.getAllProperties()

getChildComponents

Returns list of component's children Edit on GitHub

ScriptComboBox.getChildComponents()

getGlobalPositionX

Returns the absolute x-position relative to the interface. Edit on GitHub

ScriptComboBox.getGlobalPositionX()

getGlobalPositionY

Returns the absolute y-position relative to the interface. Edit on GitHub

ScriptComboBox.getGlobalPositionY()

getHeight

Returns the height of the component. Edit on GitHub

ScriptComboBox.getHeight()

getId

Returns the ID of the component. Edit on GitHub

ScriptComboBox.getId()

getItemText

Returns the currently selected item text. Edit on GitHub

ScriptComboBox.getItemText()

getLocalBounds

Returns a [x, y, w, h] array that was reduced by the given amount. Edit on GitHub

ScriptComboBox.getLocalBounds(float reduceAmount)

getValue

Returns the current value. Edit on GitHub

ScriptComboBox.getValue()

getValueNormalized

Returns the normalized value. Edit on GitHub

ScriptComboBox.getValueNormalized()

getWidth

Returns the width of the component. Edit on GitHub

ScriptComboBox.getWidth()

grabFocus

Call this method in order to grab the keyboard focus for this component. Edit on GitHub

ScriptComboBox.grabFocus()

loseFocus

Call this method in order to give away the focus for this component. Edit on GitHub

ScriptComboBox.loseFocus()

sendRepaintMessage

Manually sends a repaint message for the component. Edit on GitHub

ScriptComboBox.sendRepaintMessage()

set

Sets the property. Edit on GitHub

ScriptComboBox.set(String propertyName, var value)

setColour

sets the colour of the component (BG, IT1, IT2, TXT). Edit on GitHub

ScriptComboBox.setColour(int colourId, int colourAs32bitHex)

setConsumedKeyPresses

Registers a selection of key presses to be consumed by this component. Edit on GitHub

ScriptComboBox.setConsumedKeyPresses(var listOfKeys)

setControlCallback

Pass a inline function for a custom callback event. Edit on GitHub

ScriptComboBox.setControlCallback(var controlFunction)

setKeyPressCallback

Adds a callback to react on key presses (when this component is focused). Edit on GitHub

ScriptComboBox.setKeyPressCallback(var keyboardFunction)

setLocalLookAndFeel

Attaches the local look and feel to this component. Edit on GitHub

ScriptComboBox.setLocalLookAndFeel(var lafObject)

setPosition

Sets the position of the component. Edit on GitHub

ScriptComboBox.setPosition(int x, int y, int w, int h)

setPropertiesFromJSON

Restores all properties from a JSON object. Edit on GitHub

ScriptComboBox.setPropertiesFromJSON( var jsonData)

setStyleSheetClass

Sets the given class selectors for the component stylesheet. Edit on GitHub

ScriptComboBox.setStyleSheetClass( String classIds)

setStyleSheetProperty

Sets a variable for this component that can be queried from a style sheet. Edit on GitHub

ScriptComboBox.setStyleSheetProperty( String variableId,  var value,  String type)

setStyleSheetPseudoState

Programatically sets a pseudo state (:hover, :active, :checked, :focus, :disabled) that will be used by the CSS renderer. Edit on GitHub

ScriptComboBox.setStyleSheetPseudoState( String pseudoState)

setTooltip

Shows a informative text on mouse hover. Edit on GitHub

ScriptComboBox.setTooltip( String tooltip)

setValue

Sets the current value Edit on GitHub

ScriptComboBox.setValue(var newValue)

setValueNormalized

Sets the current value from a range 0.0 ... 1.0. Edit on GitHub

ScriptComboBox.setValueNormalized(double normalizedValue)

setValueWithUndo

Sets the current value and adds it to the undo list. Don't call this from onControl! Edit on GitHub

ScriptComboBox.setValueWithUndo(var newValue)

setZLevel

Changes the depth hierarchy (z-axis) of sibling components (Back, Default, Front or AlwaysOnTop). Edit on GitHub

ScriptComboBox.setZLevel(String zLevel)

showControl

Hides / Shows the control. Edit on GitHub

ScriptComboBox.showControl(bool shouldBeVisible)

updateContentPropertyInternal

This updates the internal content data object from the script processor. Edit on GitHub

ScriptComboBox.updateContentPropertyInternal(int propertyId,  var newValue)

updateValueFromProcessorConnection

Updates the value from the processor connection. Call this method whenever the module state has changed and you want to refresh the knob value to show the current state. Edit on GitHub

ScriptComboBox.updateValueFromProcessorConnection()