index :: ui

ui.radio

aliases: [ui.radio], [ui.hrd], [ui.hrd], [ui.vrd], [ui.vrd*]

counterpart of the vanilla radio toggle

available since version: 0.1

---

information

[ui.hrd] alias for horizontal radio, [ui.vrd] alias for vertical radio, [ui.hrd*] alias for horizontal radio checklist.

arguments:

• NCELLS number of cells
  type: float
  

methods:

• + STEP moves several steps forward on a loop (single mode only)
  

• - STEP moves several step backwards on a loop (single mode only)
  

• cellsize set cell size (resize widget)
  parameters:
  • X cell size in pixels
    type: int
    required: True
    
• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• euclid set euclid pattern (checklist mode only)
  parameters:

  • BEATS requested number of beats
    type: int
    required: True
    

  • [OFFSET] pattern offset (rotation to the right)
    type: int
    

• flip flips radio (only in checklist mode)
  

• hexbeat set hexbeat pattern (checklist mode only)
  parameters:
  • HEXSTR hex string. For example, 0xF1 will set 1 1 1 1 0 0 0 1 pattern
    type: symbol
    required: True
    

• interp for this object acts as load, no interpolation performed
  

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• next moves to next position until last cell is reached (single mode only)
  

• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• prev moves to previous position until first cell is reached (single mode only)
  

• random select random cells. If called as [random move( moves to another random cell (excluding the current one)
  

• reset reset radio (only in checklist mode)
  

• rotate left rotate (checklist mode only)
  parameters:
  • STEPS number of steps
    type: int
    required: True
    
• set sets radio without output
  parameters:
  • V new value
    type: float
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @nitems Get/set number of items
  type: int
  range: 2..128
  default: 8
  

• @mode Get/set check list mode. If true acts as checklist
  type: bool
  default: 0
  

• @value Get/set widget value (float or list)
  type: list
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 120 15
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @active_color Get/set active color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.75 1 1
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.93 0.93 0.93 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @mouse_events Get/set mouse events output mode. If on outputs @mouse_down and @mouse_drag events
  type: bool
  default: 0
  

inlets:

• outputs current radio state
  type: control

outlets:

• output value
  type: control

keywords:

ui radio

See also: [ui.matrix]

Authors: Pierre Guillot

License: GPL3 or later