index :: ui

ui.preset

Preset manager

available since version: 0.1

---

information

Saves presets value of UI objects that have @presetname property. Can handle UI objects only on the save canvas, no subpatches or abstractions are supported. NOTE: if no UI widgets with @presetname on canvas - Shift-click is disabled. Active slot is highlighted, available slots are dark gray

methods:

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

• clearall clear all existing presets
  

• duplicate fill empty presets by coping exiting values
  

• interp loads linearry interpolated value between preset, for example: 1.5 means load interpolated value between preset 1 and 2.
  parameters:
  • IDX preset interpolation index
    type: float
    required: True
    
• 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
    

• read read presets from file
  parameters:
  • PATH path to preset file
    type: symbol
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• write read presets from file
  parameters:
  • PATH path to preset file
    type: symbol
    required: True
    

properties:

• @current (readonly) Get current preset index
  type: int
  default: -1
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 102 42
  

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

• @empty_color Get/set empty cell color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.86 0.86 0.86 1
  

• @stored_color Get/set stored cell 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:

type: control

keywords:

ui preset

See also: [preset.float] [preset.storage]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later