Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 5.33 KB

components-gui.md

File metadata and controls

117 lines (79 loc) · 5.33 KB
Raw

GUI components

gui:button

A button. Can be bound to a specific control or execute a script when clicked.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • values : Property (array) : array of values to send to bound control when button clicked
  • on-click : Property (string text/x-praxis-script) : script to run when button is clicked (advanced)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:combobox

A combobox. Automatically picks up allowed values from the bound control if specified.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • values : Property (array) : array of selectable values, or empty to pick up the allowed values from the bound control
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:filefield

Specify a file. When clicked, a file selection dialog is opened.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:h-rangeslider

A range slider. Currently only supports binding to a range property that accepts input and output points. The only components that support that so far are audio:sampleplayer, audio:sampling:player and audio:sampling:looper.

If a minimum and maximum value are not set, the range slider will attempt to configure these from the bound control. If these are not specified by the control they will default to 0 and 1 respectively.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • minimum : Property (empty or number)
  • maximum : Property (empty or number)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:h-slider

A horizontal slider.

If a minimum, maximum or scale value are not set, the slider will attempt to configure these from the bound control. If these are not specified by the control they will default to 0, 1 and Linear respectively.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • minimum : Property (empty or number)
  • maximum : Property (empty or number)
  • scale : Property (empty or string)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:panel

A panel to contain other components

  • label : Property (string)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:tabs

Arrange child components in tabs. Ideally, use a gui:panel for the children of this component. The value of label on each child component will be used as the tab name.

  • label : Property (string)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui-textfield

A simple textfield that can be bound to any control.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:togglebutton

A toggle button.

When syncing to a bound control, the value of on-value is used to determine whether the button appears selected.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • on-value : Property : value sent to the bound control when the button is selected
  • off-value : Property : values sent to the bound control when the button is de-selected
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:v-slider

A vertical slider.

If a minimum, maximum or scale value are not set, the slider will attempt to configure these from the bound control. If these are not specified by the control they will default to 0, 1 and Linear respectively.

  • label : Property (string)
  • binding : Property (control address or empty) : address of the control to bind to
  • minimum : Property (empty or number)
  • maximum : Property (empty or number)
  • scale : Property (empty or string)
  • layout : Property (string) : a layout string (based on the format of MigLayout)

gui:xy-pad

An XY pad. Different controls can be bound to vertical and horizontal movement.

If minimum, maximum or scale value are not set, the pad will attempt to configure these from the bound controls. If these are not specified by the control they will default to 0, 1 and Linear respectively.

  • label : Property (string)
  • binding-x : Property (control address or empty) : address of the control to bind horizontal movement to
  • binding-y : Property (control address or empty) : address of the control to bind vertical movement to
  • minimum-x : Property (empty or number)
  • minimum-y : Property (empty or number)
  • maximum-x : Property (empty or number)
  • maximum-y : Property (empty or number)
  • scale-x : Property (empty or string)
  • scale-y : Property (empty or string)
  • layout : Property (string) : a layout string (based on the format of MigLayout)