index :: ui

ui.toggle

aliases: [ui.t]

modern toggle widget

available since version: 0.1

---

information

This is the ceammc counterpart of the vanilla toggle

methods:

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• dump dumps all object info to Pd console window
  

• interp for this object acts as load, no 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 sets toggle state without output
  

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

properties:

• @value Get/set widget logical value
  type: float
  enum: 0, 1
  default: 0
  

• @on_value Get/set output on value
  type: float
  default: 1
  

• @off_value Get/set output off value
  type: float
  default: 0
  

• @midi_channel Get/set binded MIDI channel. 0 means listen to all channels
  type: int
  range: 0..16
  default: 0
  

• @midi_control Get/set binded MIDI controller number. -1 means not binded to any controller.
  type: int
  range: -1..127
  default: -1
  

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

inlets:

• change toggle state
  type: control

outlets:

• outputs @on_value or @off_value (by default 0 or 1)
  type: control

keywords:

ui toggle

See also: [ui.bang]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later