index :: ui

ui.menu

Dropdown menu

available since version: 0.1

---

methods:

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

• erase clears all items menu
  

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• delete removes item from menu
  parameters:
  • IDX removed item index
    type: int
    required: True
    
• file_glob fill menu with filenames.
  parameters:

  • PATTERN filename pattern, like * (all files), *.wav (all wav files) etc.
    type: symbol
    required: True
    

  • [DIR] search directory. If omitted - search in patch directory. Performs tilde (~) expansion to home directory. To elide long filenames see @max_length property.
    type: symbol
    

• insert inserts new menu 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
    
• pos set UI element position
  parameters:

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

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

• set silently sets menu state.
  parameters:
  • IDX item index
    type: int
    required: True
    
• set_item renames menu item
  parameters:

  • IDX item index
    type: int
    required: True
    

  • ATOM item name
    type: list
    required: True
    

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

properties:

• @items Get/set list of menu items
  type: list
  

• @index Get/set current menu item index
  type: int
  default: -1
  

• @value Get/set current menu item value
  type: atom
  

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

• @max_length Get/set maximum displayed item character length
  type: int
  range: 10..1024
  default: 100
  

• @open Get/set opened state
  type: bool
  default: 0
  

• @title (readonly) Get current element text
  type: symbol
  

• @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 16
  

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

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

• outputs current menu state as list: INDEX ITEM_NAME
  type: control

outlets:

• output
  type: control

keywords:

ui menu

See also: [ui.radio]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later