index :: ui

ui.keyboard

aliases: [ui.hk], [ui.vkeyboard], [ui.vk]

keyboard widget

available since version: 0.1

---

information

Piano keyboard widget [ui.vkeyboard] and [ui.vk] - aliases for vertical keyboard

arguments:

• NKEYS number of keys
  type: int
  

• SHIFT pitch of starting key
  type: int
  

methods:

• dump dumps all object info to Pd console window
  

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

• @keys Get/set number of keys
  type: int
  range: 5..88
  default: 61
  

• @shift Get/set MIDI pitch of starting key
  type: int
  range: 6..88
  default: 36
  

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

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

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

• control inlet
  type: control

outlets:

• list from two elements: MIDI pitch, MIDI velocity. Velocity depends from key press position.
  type: control

keywords:

ui keyboard

See also: [ui.preset]

Authors: Alex Nadzharov, Serge Poltavsky

License: GPL3 or later