index :: ui

ui.number

aliases: [ui.n]

counterpart of the vanilla [nbx]

available since version: 0.1

---

information

Display mode: keys '-'(Down) and '+'(Up) increment value. Mouse drag changes value. Default step is 1/pixel. Holding SHIFT divide step by 100. Holding CTRL multiply by 10. Input mode: Double click to enter new value. Accepted keys: -.0123456789. Press ENTER or TAB key to finish. ESCAPE undo input, BACKSPACE removes last character.

methods:

• set sets slider value without output
  parameters:
  • V new value
    type: float
    required: True
    

• ++ increment slider value without output
  

• – decrement slider value without output
  

• + add value to slider without output
  parameters:
  • V added value
    type: float
    required: True
    
• - subtract value from slider without output
  parameters:
  • V subtracted value
    type: float
    required: True
    

---

multiply slider value without output
parameters:

• V multiplied value
  type: float
  required: True
  

• / divide slider value without output
  parameters:
  • V denominator value
    type: float
    required: True
    
• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• interp interplolates between presets
  parameters:
  • IDX preset fraction index
    type: float
    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
    

properties:

• @min Get/set minimum value
  type: float
  default: -inf
  

• @max Get/set maximum value
  type: float
  default: +inf
  

• @value Get/set widget value
  type: float
  default: 0
  

• @display_only Get/set interaction mode. If true: react only to received Pd messages, but do not react to mouse/keyboard events. If false: react to all supported events.
  type: bool
  default: 0
  

• @digits Get/set number of digits. If -1 - no fixed digits used
  type: int
  range: -1..9
  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: 53 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
  

• @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 value
  type: control

outlets:

• number value
  type: control

keywords:

ui number

See also: [ui.number~]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later