ScriptButton

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

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

Class methods

addToMacroControl

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

ScriptButton.addToMacroControl(int macroIndex)

changed

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

ScriptButton.changed()

createLocalLookAndFeel

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

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

fadeComponent

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

ScriptButton.fadeComponent(bool shouldBeVisible, int milliseconds)

get

returns the value of the property. Edit on GitHub

ScriptButton.get(String propertyName)

getAllProperties

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

ScriptButton.getAllProperties()

getChildComponents

Returns list of component's children Edit on GitHub

ScriptButton.getChildComponents()

getGlobalPositionX

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

ScriptButton.getGlobalPositionX()

getGlobalPositionY

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

ScriptButton.getGlobalPositionY()

getHeight

Returns the height of the component. Edit on GitHub

ScriptButton.getHeight()

getId

Returns the ID of the component. Edit on GitHub

ScriptButton.getId()

getLocalBounds

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

ScriptButton.getLocalBounds(float reduceAmount)

getValue

Returns the current value. Edit on GitHub

ScriptButton.getValue()

getValueNormalized

Returns the normalized value. Edit on GitHub

ScriptButton.getValueNormalized()

getWidth

Returns the width of the component. Edit on GitHub

ScriptButton.getWidth()

grabFocus

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

ScriptButton.grabFocus()

loseFocus

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

ScriptButton.loseFocus()

sendRepaintMessage

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

ScriptButton.sendRepaintMessage()

set

Sets the property. Edit on GitHub

ScriptButton.set(String propertyName, var value)

setColour

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

ScriptButton.setColour(int colourId, int colourAs32bitHex)

setConsumedKeyPresses

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

ScriptButton.setConsumedKeyPresses(var listOfKeys)

setControlCallback

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

ScriptButton.setControlCallback(var controlFunction)

setKeyPressCallback

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

ScriptButton.setKeyPressCallback(var keyboardFunction)

setLocalLookAndFeel

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

ScriptButton.setLocalLookAndFeel(var lafObject)

setPopupData

Sets a FloatingTile that is used as popup. Edit on GitHub

ScriptButton.setPopupData(var jsonData, var position)

setPosition

Sets the position of the component. Edit on GitHub

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

setPropertiesFromJSON

Restores all properties from a JSON object. Edit on GitHub

ScriptButton.setPropertiesFromJSON( var jsonData)

setStyleSheetClass

Sets the given class selectors for the component stylesheet.

ScriptButton.setStyleSheetClass( String classIds)

This will write the given CSS class selectors to the component so that it can change what selectors are applied to the component.

The argument expects a string that follows the syntax of defining class selectors in HTML: a whitespace separated list of class selectors.

".classone .classtwo .classthree"

Calling this method will update the classes for the component and invalidate the style sheet to be recalculated. This can be used to alter the appearance of a UI component.

For a change of a single property using the setStyleSheetProperty function might be a better tool.

setStyleSheetProperty

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

ScriptButton.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

ScriptButton.setStyleSheetPseudoState( String pseudoState)

setTooltip

Shows a informative text on mouse hover. Edit on GitHub

ScriptButton.setTooltip( String tooltip)

setValue

Sets the current value Edit on GitHub

ScriptButton.setValue(var newValue)

setValueNormalized

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

ScriptButton.setValueNormalized(double normalizedValue)

setValueWithUndo

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

ScriptButton.setValueWithUndo(var newValue)

setZLevel

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

ScriptButton.setZLevel(String zLevel)

showControl

Hides / Shows the control. Edit on GitHub

ScriptButton.showControl(bool shouldBeVisible)

updateContentPropertyInternal

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

ScriptButton.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

ScriptButton.updateValueFromProcessorConnection()