index :: ui

ui.tab

displays a list of text buttons or text toggles

available since version: 0.1

---

methods:

• + STEP moves several steps forward on a loop (single mode only), output newly selected item
  

• - STEP moves several step backwards on a loop (single mode only), output newly selected item
  

• append appends new tab item
  parameters:
  • ATOMS item name
    type: list
    required: True
    

• erase clears all tab menu
  

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• delete removes item from tab
  parameters:
  • IDX removed item index
    type: int
    required: True
    

• flip flips radio (only in checklist mode)
  

• insert inserts new tab item before specified position
  parameters:

  • IDX item position
    type: int
    required: True
    

  • ATOM item name
    type: atom
    required: True
    

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

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

• next moves to next item until last item is reached (single mode only). Output new item
  

• 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 item until first item is reached (single mode only). Output new item
  

• random select random item. If called [random move( moves to random item (excluding the current one)
  

• select selects specified item in tab
  parameters:
  • IDX item index
    type: int
    required: True
    
• set silently sets tab state.
  parameters:
  • IDX item index
    type: int
    required: True
    
• set_item renames tab item
  parameters:

  • IDX item index
    type: int
    required: True
    

  • ATOMS item name
    type: list
    required: True
    

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @items Get/set list of tab names
  type: list
  

• @toggle Get/set toggle mode. In toggle moe multiple selection is possible
  type: bool
  default: 0
  

• @orientation Get/set tab orientation. 1 is vertical, 0 is horizontal
  type: bool
  default: 0
  

• @selected (readonly) Get list of selected items (in toggle mode)
  type: list
  

• @current (readonly) Get current selected index (in switch mode)
  type: int
  default: 0
  

• @count (readonly) Get number of tabs
  type: int
  default: 0
  

• @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: 100 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
  

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

• @hover_color Get/set hover color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.5 0.5 0.5 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
  

inlets:

• in single mode outputs tab state as list: INDEX TAB_NAME. In toggle mode outputs current state like: @selected 0 1 0 1 0 etc. and list of two values: [CHANGED_IDX CHANGED_VALUE]
  type: control

outlets:

• output
  type: control

keywords:

ui tab

See also: [ui.menu]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later